Serialized Form

Package com.mypurecloud.sdk.v2

Class com.mypurecloud.sdk.v2.ApiDateFormat

class ApiDateFormat extends DateFormat implements Serializable

Serialized Fields

formats

List<SimpleDateFormat> formats

formatStrings

List<String> formatStrings

Exception com.mypurecloud.sdk.v2.ApiException

class ApiException extends Exception implements Serializable

Serialized Fields

body

String body

headers

Map<String,String> headers

statusCode

int statusCode

Class com.mypurecloud.sdk.v2.FileWatcher.FileEvent

class FileEvent extends EventObject implements Serializable

Class com.mypurecloud.sdk.v2.JodaApiDateFormat

class JodaApiDateFormat extends DateFormat implements Serializable

Serialized Fields

formats

List<org.joda.time.format.DateTimeFormatter> formats

printer

org.joda.time.format.DateTimePrinter printer

Class com.mypurecloud.sdk.v2.LocalDateDeserializer

class LocalDateDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<LocalDate> implements Serializable

Class com.mypurecloud.sdk.v2.LocalDateSerializer

class LocalDateSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<LocalDate> implements Serializable

Package com.mypurecloud.sdk.v2.extensions

Class com.mypurecloud.sdk.v2.extensions.AuthResponse

class AuthResponse extends Object implements Serializable

Serialized Fields

access_token

String access_token

error

String error

expires_in

int expires_in

refresh_token

String refresh_token

token_type

String token_type

Package com.mypurecloud.sdk.v2.model

Class com.mypurecloud.sdk.v2.model.AcceleratorInput

class AcceleratorInput extends Object implements Serializable

Serialized Fields

acceleratorId

String acceleratorId

dryRun

Boolean dryRun

parameters

List<AcceleratorParameter> parameters

Class com.mypurecloud.sdk.v2.model.AcceleratorList

class AcceleratorList extends Object implements Serializable

Serialized Fields

entities

List<AcceleratorMetadata> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.AcceleratorMetadata

class AcceleratorMetadata extends Object implements Serializable

Serialized Fields

classification

String classification

description

String description

id

String id

name

String name

origin

AcceleratorMetadata.OriginEnum origin

selfUri

String selfUri

tags

List<String> tags

type

AcceleratorMetadata.TypeEnum type

Class com.mypurecloud.sdk.v2.model.AcceleratorParameter

class AcceleratorParameter extends Object implements Serializable

Serialized Fields

name

String name

value

String value

Class com.mypurecloud.sdk.v2.model.AcceleratorSpecification

class AcceleratorSpecification extends Object implements Serializable

Serialized Fields

classification

String classification

description

String description

documentation

List<MetadataDocumentation> documentation

id

String id

name

String name

origin

AcceleratorSpecification.OriginEnum origin

permissions

List<String> permissions

presentation

List<MetadataPresentation> presentation

products

List<String> products

results

MetadataResults results

selfUri

String selfUri

tags

List<String> tags

type

AcceleratorSpecification.TypeEnum type

Class com.mypurecloud.sdk.v2.model.AcdEndDetailEventTopicAcdEndEvent

class AcdEndDetailEventTopicAcdEndEvent extends Object implements Serializable

Serialized Fields

acdOutcome

AcdEndDetailEventTopicAcdEndEvent.AcdOutcomeEnum acdOutcome

addressFrom

String addressFrom

addressTo

String addressTo

ani

String ani

answeredUserId

String answeredUserId

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Integer callbackScheduledTime

callbackUserName

String callbackUserName

connectedDurationMs

Integer connectedDurationMs

conversationExternalContactIds

List<String> conversationExternalContactIds

conversationExternalOrganizationIds

List<String> conversationExternalOrganizationIds

conversationId

String conversationId

direction

AcdEndDetailEventTopicAcdEndEvent.DirectionEnum direction

disconnectType

AcdEndDetailEventTopicAcdEndEvent.DisconnectTypeEnum disconnectType

divisionId

String divisionId

dnis

String dnis

eventTime

Integer eventTime

mediaType

AcdEndDetailEventTopicAcdEndEvent.MediaTypeEnum mediaType

messageType

AcdEndDetailEventTopicAcdEndEvent.MessageTypeEnum messageType

participantId

String participantId

provider

String provider

queueId

String queueId

requestedLanguageId

String requestedLanguageId

requestedRoutings

List<AcdEndDetailEventTopicAcdEndEvent.RequestedRoutingsEnum> requestedRoutings

requestedRoutingSkillIds

List<String> requestedRoutingSkillIds

requestedRoutingUserIds

List<String> requestedRoutingUserIds

routingPriority

Integer routingPriority

sessionId

String sessionId

subject

String subject

usedRouting

AcdEndDetailEventTopicAcdEndEvent.UsedRoutingEnum usedRouting

Class com.mypurecloud.sdk.v2.model.AcdStartDetailEventTopicAcdStartEvent

class AcdStartDetailEventTopicAcdStartEvent extends Object implements Serializable

Serialized Fields

addressFrom

String addressFrom

addressTo

String addressTo

ani

String ani

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Integer callbackScheduledTime

callbackUserName

String callbackUserName

conversationExternalContactIds

List<String> conversationExternalContactIds

conversationExternalOrganizationIds

List<String> conversationExternalOrganizationIds

conversationId

String conversationId

direction

AcdStartDetailEventTopicAcdStartEvent.DirectionEnum direction

divisionId

String divisionId

dnis

String dnis

eventTime

Integer eventTime

mediaType

AcdStartDetailEventTopicAcdStartEvent.MediaTypeEnum mediaType

messageType

AcdStartDetailEventTopicAcdStartEvent.MessageTypeEnum messageType

participantId

String participantId

provider

String provider

queueId

String queueId

sessionId

String sessionId

subject

String subject

Class com.mypurecloud.sdk.v2.model.AchievedOutcome

class AchievedOutcome extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.AcknowledgeScreenRecordingRequest

class AcknowledgeScreenRecordingRequest extends Object implements Serializable

Serialized Fields

conversationId

String conversationId

participantJid

String participantJid

roomId

String roomId

Class com.mypurecloud.sdk.v2.model.Action

class Action extends Object implements Serializable

Serialized Fields

category

String category

config

ActionConfig config

contract

ActionContract contract

id

String id

integrationId

String integrationId

name

String name

secure

Boolean secure

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.ActionAggregateDataContainer

class ActionAggregateDataContainer extends Object implements Serializable

Serialized Fields

data

List<StatisticalResponse> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.ActionAggregateQueryClause

class ActionAggregateQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<ActionAggregateQueryPredicate> predicates

type

ActionAggregateQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ActionAggregateQueryFilter

class ActionAggregateQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<ActionAggregateQueryClause> clauses

predicates

List<ActionAggregateQueryPredicate> predicates

type

ActionAggregateQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ActionAggregateQueryPredicate

class ActionAggregateQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

ActionAggregateQueryPredicate.DimensionEnum dimension

operator

ActionAggregateQueryPredicate.OperatorEnum operator

range

NumericRange range

type

ActionAggregateQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.ActionAggregateQueryResponse

class ActionAggregateQueryResponse extends Object implements Serializable

Serialized Fields

results

List<ActionAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.ActionAggregationQuery

class ActionAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

ActionAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

ActionAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<ActionAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<ActionAggregationQuery.MetricsEnum> metrics

timeZone

String timeZone

views

List<ActionAggregationView> views

Class com.mypurecloud.sdk.v2.model.ActionAggregationView

class ActionAggregationView extends Object implements Serializable

Serialized Fields

function

ActionAggregationView.FunctionEnum function

name

String name

range

AggregationRange range

target

ActionAggregationView.TargetEnum target

Class com.mypurecloud.sdk.v2.model.ActionAsyncAggregateQueryResponse

class ActionAsyncAggregateQueryResponse extends Object implements Serializable

Serialized Fields

cursor

String cursor

results

List<ActionAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.ActionAsyncAggregationQuery

class ActionAsyncAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

ActionAsyncAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

ActionAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<ActionAsyncAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<ActionAsyncAggregationQuery.MetricsEnum> metrics

pageSize

Integer pageSize

timeZone

String timeZone

views

List<ActionAggregationView> views

Class com.mypurecloud.sdk.v2.model.ActionConfig

class ActionConfig extends Object implements Serializable

Serialized Fields

_request

RequestConfig _request

response

ResponseConfig response

timeoutSeconds

Integer timeoutSeconds

Class com.mypurecloud.sdk.v2.model.ActionContract

class ActionContract extends Object implements Serializable

Serialized Fields

input

ActionInput input

output

ActionOutput output

Class com.mypurecloud.sdk.v2.model.ActionContractInput

class ActionContractInput extends Object implements Serializable

Serialized Fields

input

PostInputContract input

output

PostOutputContract output

Class com.mypurecloud.sdk.v2.model.ActionEntityListing

class ActionEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Action> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ActionEventActionMap

class ActionEventActionMap extends Object implements Serializable

Serialized Fields

displayName

String displayName

id

String id

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.ActionInput

class ActionInput extends Object implements Serializable

Serialized Fields

inputSchema

JsonSchemaDocument inputSchema

inputSchemaFlattened

JsonSchemaDocument inputSchemaFlattened

inputSchemaUri

String inputSchemaUri

Class com.mypurecloud.sdk.v2.model.ActionMap

class ActionMap extends Object implements Serializable

Serialized Fields

action

ActionMapAction action

actionMapScheduleGroups

ActionMapScheduleGroups actionMapScheduleGroups

activation

Activation activation

createdDate

Date createdDate

displayName

String displayName

endDate

Date endDate

id

String id

ignoreFrequencyCap

Boolean ignoreFrequencyCap

isActive

Boolean isActive

modifiedDate

Date modifiedDate

pageUrlConditions

List<UrlCondition> pageUrlConditions

selfUri

String selfUri

startDate

Date startDate

triggerWithEventConditions

List<EventCondition> triggerWithEventConditions

triggerWithOutcomePercentileConditions

List<OutcomePercentileCondition> triggerWithOutcomePercentileConditions

triggerWithOutcomeProbabilityConditions

List<OutcomeProbabilityCondition> triggerWithOutcomeProbabilityConditions

triggerWithSegments

List<String> triggerWithSegments

version

Integer version

weight

Integer weight

Class com.mypurecloud.sdk.v2.model.ActionMapAction

class ActionMapAction extends Object implements Serializable

Serialized Fields

actionTargetId

String actionTargetId

actionTemplate

ActionMapActionTemplate actionTemplate

architectFlowFields

ArchitectFlowFields architectFlowFields

isPacingEnabled

Boolean isPacingEnabled

mediaType

ActionMapAction.MediaTypeEnum mediaType

openActionFields

OpenActionFields openActionFields

props

ActionProperties props

webMessagingOfferFields

WebMessagingOfferFields webMessagingOfferFields

Class com.mypurecloud.sdk.v2.model.ActionMapActionTemplate

class ActionMapActionTemplate extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ActionMapEstimateOutcomeCriteria

class ActionMapEstimateOutcomeCriteria extends Object implements Serializable

Serialized Fields

maxProbability

Float maxProbability

outcomeId

String outcomeId

probability

Float probability

Class com.mypurecloud.sdk.v2.model.ActionMapEstimateRequest

class ActionMapEstimateRequest extends Object implements Serializable

Serialized Fields

outcomeCriteria

ActionMapEstimateOutcomeCriteria outcomeCriteria

segmentIds

List<String> segmentIds

Class com.mypurecloud.sdk.v2.model.ActionMapEstimateResult

class ActionMapEstimateResult extends Object implements Serializable

Serialized Fields

outcomesScoresCount

Integer outcomesScoresCount

perSegmentCounts

List<SegmentEstimateCount> perSegmentCounts

qualifiedSessionCount

Integer qualifiedSessionCount

totalSessionCount

Integer totalSessionCount

Class com.mypurecloud.sdk.v2.model.ActionMapListing

class ActionMapListing extends Object implements Serializable

Serialized Fields

entities

List<ActionMap> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ActionMapScheduleGroup

class ActionMapScheduleGroup extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.ActionMapScheduleGroups

class ActionMapScheduleGroups extends Object implements Serializable

Serialized Fields

actionMapScheduleGroup

ActionMapScheduleGroup actionMapScheduleGroup

emergencyActionMapScheduleGroup

ActionMapScheduleGroup emergencyActionMapScheduleGroup

Class com.mypurecloud.sdk.v2.model.ActionOutput

class ActionOutput extends Object implements Serializable

Serialized Fields

errorSchema

JsonSchemaDocument errorSchema

errorSchemaFlattened

Object errorSchemaFlattened

errorSchemaUri

String errorSchemaUri

successSchema

JsonSchemaDocument successSchema

successSchemaFlattened

JsonSchemaDocument successSchemaFlattened

successSchemaUri

String successSchemaUri

Class com.mypurecloud.sdk.v2.model.ActionProperties

class ActionProperties extends Object implements Serializable

Serialized Fields

webchatAcceptText

String webchatAcceptText

webchatDeclineText

String webchatDeclineText

webchatPrompt

String webchatPrompt

webchatSurvey

ActionSurvey webchatSurvey

webchatTitleText

String webchatTitleText

Class com.mypurecloud.sdk.v2.model.Actions

class Actions extends Object implements Serializable

Serialized Fields

skillsToRemove

List<SkillsToRemove> skillsToRemove

Class com.mypurecloud.sdk.v2.model.ActionSurvey

class ActionSurvey extends Object implements Serializable

Serialized Fields

questions

List<JourneySurveyQuestion> questions

Class com.mypurecloud.sdk.v2.model.ActionTarget

class ActionTarget extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

description

String description

id

String id

modifiedDate

Date modifiedDate

name

String name

selfUri

String selfUri

serviceLevel

ServiceLevel serviceLevel

shortAbandonThreshold

Integer shortAbandonThreshold

state

ActionTarget.StateEnum state

supportedMediaTypes

List<ActionTarget.SupportedMediaTypesEnum> supportedMediaTypes

userData

List<KeyValue> userData

Class com.mypurecloud.sdk.v2.model.ActionTargetListing

class ActionTargetListing extends Object implements Serializable

Serialized Fields

entities

List<ActionTarget> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ActionTemplate

class ActionTemplate extends Object implements Serializable

Serialized Fields

contentOffer

ContentOffer contentOffer

createdDate

Date createdDate

description

String description

id

String id

mediaType

ActionTemplate.MediaTypeEnum mediaType

modifiedDate

Date modifiedDate

name

String name

selfUri

String selfUri

state

ActionTemplate.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.ActionTemplateListing

class ActionTemplateListing extends Object implements Serializable

Serialized Fields

entities

List<ActionTemplate> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.Activation

class Activation extends Object implements Serializable

Serialized Fields

delayInSeconds

Integer delayInSeconds

type

String type

Class com.mypurecloud.sdk.v2.model.ActiveAlertCount

class ActiveAlertCount extends Object implements Serializable

Serialized Fields

count

Integer count

Class com.mypurecloud.sdk.v2.model.ActivityCode

class ActivityCode extends Object implements Serializable

Serialized Fields

agentTimeOffSelectable

Boolean agentTimeOffSelectable

category

ActivityCode.CategoryEnum category

countsAsPaidTime

Boolean countsAsPaidTime

countsAsWorkTime

Boolean countsAsWorkTime

id

String id

isActive

Boolean isActive

isDefault

Boolean isDefault

lengthInMinutes

Integer lengthInMinutes

metadata

WfmVersionedEntityMetadata metadata

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ActivityCodeContainer

class ActivityCodeContainer extends Object implements Serializable

Serialized Fields

activityCodes

Map<String,ActivityCode> activityCodes

metadata

WfmVersionedEntityMetadata metadata

Class com.mypurecloud.sdk.v2.model.ActivityCodeReference

class ActivityCodeReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

secondaryPresences

List<SecondaryPresence> secondaryPresences

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.AcwDetailEventTopicAfterCallWorkEvent

class AcwDetailEventTopicAfterCallWorkEvent extends Object implements Serializable

Serialized Fields

addressFrom

String addressFrom

addressTo

String addressTo

ani

String ani

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Integer callbackScheduledTime

callbackUserName

String callbackUserName

conversationExternalContactIds

List<String> conversationExternalContactIds

conversationExternalOrganizationIds

List<String> conversationExternalOrganizationIds

conversationId

String conversationId

direction

AcwDetailEventTopicAfterCallWorkEvent.DirectionEnum direction

dnis

String dnis

eventTime

Integer eventTime

mediaType

AcwDetailEventTopicAfterCallWorkEvent.MediaTypeEnum mediaType

messageType

AcwDetailEventTopicAfterCallWorkEvent.MessageTypeEnum messageType

participantId

String participantId

provider

String provider

queueId

String queueId

sessionId

String sessionId

subject

String subject

userId

String userId

wrapupCode

String wrapupCode

wrapupDurationMs

Integer wrapupDurationMs

wrapupNotes

String wrapupNotes

Class com.mypurecloud.sdk.v2.model.AcwSettings

class AcwSettings extends Object implements Serializable

Serialized Fields

timeoutMs

Integer timeoutMs

wrapupPrompt

AcwSettings.WrapupPromptEnum wrapupPrompt

Class com.mypurecloud.sdk.v2.model.AddAdherenceExplanationAdminRequest

class AddAdherenceExplanationAdminRequest extends Object implements Serializable

Serialized Fields

lengthMinutes

Integer lengthMinutes

notes

String notes

startDate

Date startDate

status

AddAdherenceExplanationAdminRequest.StatusEnum status

type

AddAdherenceExplanationAdminRequest.TypeEnum type

Class com.mypurecloud.sdk.v2.model.AddAdherenceExplanationAgentRequest

class AddAdherenceExplanationAgentRequest extends Object implements Serializable

Serialized Fields

lengthMinutes

Integer lengthMinutes

notes

String notes

startDate

Date startDate

type

AddAdherenceExplanationAgentRequest.TypeEnum type

Class com.mypurecloud.sdk.v2.model.AddConversationRequest

class AddConversationRequest extends Object implements Serializable

Serialized Fields

conversationId

String conversationId

Class com.mypurecloud.sdk.v2.model.AddConversationResponse

class AddConversationResponse extends Object implements Serializable

Serialized Fields

appointment

CoachingAppointmentReference appointment

conversation

ConversationReference conversation

Class com.mypurecloud.sdk.v2.model.AdditionalLanguagesIntent

class AdditionalLanguagesIntent extends Object implements Serializable

Serialized Fields

id

String id

utterances

List<NluUtterance> utterances

Class com.mypurecloud.sdk.v2.model.AdditionalLanguagesSynonyms

class AdditionalLanguagesSynonyms extends Object implements Serializable

Serialized Fields

synonyms

List<String> synonyms

Class com.mypurecloud.sdk.v2.model.AdditionalMessage

class AdditionalMessage extends Object implements Serializable

Serialized Fields

mediaIds

List<String> mediaIds

messagingTemplate

MessagingTemplateRequest messagingTemplate

stickerIds

List<String> stickerIds

textBody

String textBody

Class com.mypurecloud.sdk.v2.model.Address

class Address extends Object implements Serializable

Serialized Fields

addressDisplayable

String addressDisplayable

addressNormalized

String addressNormalized

addressRaw

String addressRaw

name

String name

nameRaw

String nameRaw

Class com.mypurecloud.sdk.v2.model.AddressableEntityRef

class AddressableEntityRef extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.AddressableLicenseDefinition

class AddressableLicenseDefinition extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.AddShiftTradeRequest

class AddShiftTradeRequest extends Object implements Serializable

Serialized Fields

acceptableIntervals

List<String> acceptableIntervals

expiration

Date expiration

initiatingShiftId

String initiatingShiftId

receivingUserId

String receivingUserId

scheduleId

String scheduleId

Class com.mypurecloud.sdk.v2.model.AddWorkPlanRotationAgentRequest

class AddWorkPlanRotationAgentRequest extends Object implements Serializable

Serialized Fields

dateRange

DateRangeWithOptionalEnd dateRange

position

Integer position

userId

String userId

Class com.mypurecloud.sdk.v2.model.AddWorkPlanRotationRequest

class AddWorkPlanRotationRequest extends Object implements Serializable

Serialized Fields

agents

List<AddWorkPlanRotationAgentRequest> agents

dateRange

DateRangeWithOptionalEnd dateRange

name

String name

pattern

WorkPlanPatternRequest pattern

Class com.mypurecloud.sdk.v2.model.ADFS

class ADFS extends Object implements Serializable

Serialized Fields

certificate

String certificate

certificates

List<String> certificates

disabled

Boolean disabled

id

String id

issuerURI

String issuerURI

name

String name

relyingPartyIdentifier

String relyingPartyIdentifier

selfUri

String selfUri

sloBinding

String sloBinding

sloURI

String sloURI

ssoTargetURI

String ssoTargetURI

Class com.mypurecloud.sdk.v2.model.AdherenceExplanationAsyncResponse

class AdherenceExplanationAsyncResponse extends Object implements Serializable

Serialized Fields

job

AdherenceExplanationJobReference job

Class com.mypurecloud.sdk.v2.model.AdherenceExplanationJob

class AdherenceExplanationJob extends Object implements Serializable

Serialized Fields

adherenceExplanation

AdherenceExplanationResponse adherenceExplanation

agentQueryResponseTemplate

AdherenceExplanationListingAgentQueryResponse agentQueryResponseTemplate

buQueryResponseTemplate

AdherenceExplanationListingBuQueryResponse buQueryResponseTemplate

downloadUrl

String downloadUrl

error

ErrorBody error

id

String id

selfUri

String selfUri

status

AdherenceExplanationJob.StatusEnum status

type

AdherenceExplanationJob.TypeEnum type

Class com.mypurecloud.sdk.v2.model.AdherenceExplanationJobReference

class AdherenceExplanationJobReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

status

AdherenceExplanationJobReference.StatusEnum status

type

AdherenceExplanationJobReference.TypeEnum type

Class com.mypurecloud.sdk.v2.model.AdherenceExplanationListing

class AdherenceExplanationListing extends Object implements Serializable

Serialized Fields

entities

List<AdherenceExplanationResponse> entities

Class com.mypurecloud.sdk.v2.model.AdherenceExplanationListingAgentQueryResponse

class AdherenceExplanationListingAgentQueryResponse extends Object implements Serializable

Serialized Fields

entities

List<AdherenceExplanationResponse> entities

Class com.mypurecloud.sdk.v2.model.AdherenceExplanationListingBuQueryResponse

class AdherenceExplanationListingBuQueryResponse extends Object implements Serializable

Serialized Fields

entities

List<AdherenceExplanationResponse> entities

Class com.mypurecloud.sdk.v2.model.AdherenceExplanationNotification

class AdherenceExplanationNotification extends Object implements Serializable

Serialized Fields

agent

UserReference agent

businessUnit

BusinessUnitReference businessUnit

id

String id

lengthMinutes

Integer lengthMinutes

managementUnit

ManagementUnitReference managementUnit

notes

String notes

selfUri

String selfUri

startDate

Date startDate

status

AdherenceExplanationNotification.StatusEnum status

type

AdherenceExplanationNotification.TypeEnum type

Class com.mypurecloud.sdk.v2.model.AdherenceExplanationResponse

class AdherenceExplanationResponse extends Object implements Serializable

Serialized Fields

agent

UserReference agent

businessUnit

BusinessUnitReference businessUnit

id

String id

lengthMinutes

Integer lengthMinutes

managementUnit

ManagementUnitReference managementUnit

notes

String notes

reviewedBy

UserReference reviewedBy

reviewedDate

Date reviewedDate

selfUri

String selfUri

startDate

Date startDate

status

AdherenceExplanationResponse.StatusEnum status

type

AdherenceExplanationResponse.TypeEnum type

Class com.mypurecloud.sdk.v2.model.AdherenceSettings

class AdherenceSettings extends Object implements Serializable

Serialized Fields

adherenceExceptionThresholdSeconds

Integer adherenceExceptionThresholdSeconds

adherenceTargetPercent

Integer adherenceTargetPercent

ignoredActivityCategories

IgnoredActivityCategories ignoredActivityCategories

nonOnQueueActivitiesEquivalent

Boolean nonOnQueueActivitiesEquivalent

severeAlertThresholdMinutes

Integer severeAlertThresholdMinutes

trackOnQueueActivity

Boolean trackOnQueueActivity

Class com.mypurecloud.sdk.v2.model.AdhocRecordingTopicConversationData

class AdhocRecordingTopicConversationData extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.AdhocRecordingTopicLockData

class AdhocRecordingTopicLockData extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateExpires

Date dateExpires

lockedBy

AdhocRecordingTopicUserData lockedBy

Class com.mypurecloud.sdk.v2.model.AdhocRecordingTopicRecordingDataV2

class AdhocRecordingTopicRecordingDataV2 extends Object implements Serializable

Serialized Fields

changeNumber

Integer changeNumber

contentLength

Integer contentLength

contentType

String contentType

conversation

AdhocRecordingTopicConversationData conversation

createdBy

AdhocRecordingTopicUserData createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

dateUploaded

Date dateUploaded

durationMillieconds

Integer durationMillieconds

filename

String filename

id

String id

lockInfo

AdhocRecordingTopicLockData lockInfo

name

String name

read

Boolean read

selfUri

String selfUri

uploadedBy

AdhocRecordingTopicUserData uploadedBy

workspace

AdhocRecordingTopicWorkspaceData workspace

Class com.mypurecloud.sdk.v2.model.AdhocRecordingTopicUserData

class AdhocRecordingTopicUserData extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.AdhocRecordingTopicWorkspaceData

class AdhocRecordingTopicWorkspaceData extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.Adjacents

class Adjacents extends Object implements Serializable

Serialized Fields

directReports

List<User> directReports

siblings

List<User> siblings

superiors

List<User> superiors

Class com.mypurecloud.sdk.v2.model.AdjustableLiveSpeakerDetection

class AdjustableLiveSpeakerDetection extends Object implements Serializable

Serialized Fields

eventName

String eventName

isPersonLikely

Boolean isPersonLikely

lineConnected

Boolean lineConnected

mode

AdjustableLiveSpeakerDetection.ModeEnum mode

preconnectDuration

String preconnectDuration

totalRingbacks

Integer totalRingbacks

Class com.mypurecloud.sdk.v2.model.AdminTimeOffRequestPatch

class AdminTimeOffRequestPatch extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

dailyDurationMinutes

Integer dailyDurationMinutes

fullDayManagementUnitDates

List<String> fullDayManagementUnitDates

metadata

WfmVersionedEntityMetadata metadata

notes

String notes

partialDayStartDateTimes

List<Date> partialDayStartDateTimes

status

AdminTimeOffRequestPatch.StatusEnum status

Class com.mypurecloud.sdk.v2.model.AfterCallWork

class AfterCallWork extends Object implements Serializable

Serialized Fields

endTime

Date endTime

startTime

Date startTime

state

AfterCallWork.StateEnum state

Class com.mypurecloud.sdk.v2.model.AfterCallWorkUpdate

class AfterCallWorkUpdate extends Object implements Serializable

Serialized Fields

afterCallWorkRequired

Boolean afterCallWorkRequired

Class com.mypurecloud.sdk.v2.model.Agent

class Agent extends Object implements Serializable

Serialized Fields

stage

String stage

Class com.mypurecloud.sdk.v2.model.AgentActivity

class AgentActivity extends Object implements Serializable

Serialized Fields

agent

User agent

agentEvaluatorActivityList

List<AgentEvaluatorActivity> agentEvaluatorActivityList

averageCriticalScore

Float averageCriticalScore

averageEvaluationScore

Integer averageEvaluationScore

highestCriticalScore

Float highestCriticalScore

highestEvaluationScore

Float highestEvaluationScore

id

String id

lowestCriticalScore

Float lowestCriticalScore

lowestEvaluationScore

Float lowestEvaluationScore

name

String name

numCriticalEvaluations

Integer numCriticalEvaluations

numEvaluations

Integer numEvaluations

numEvaluationsWithoutViewPermission

Integer numEvaluationsWithoutViewPermission

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.AgentActivityChangedTopicAgentActivity

class AgentActivityChangedTopicAgentActivity extends Object implements Serializable

Serialized Fields

activeQueueIds

List<String> activeQueueIds

dateActiveQueuesChanged

Date dateActiveQueuesChanged

id

String id

outOfOffice

AgentActivityChangedTopicOutOfOffice outOfOffice

presence

AgentActivityChangedTopicPresence presence

routingStatus

AgentActivityChangedTopicRoutingStatus routingStatus

Class com.mypurecloud.sdk.v2.model.AgentActivityChangedTopicOrganizationPresence

class AgentActivityChangedTopicOrganizationPresence extends Object implements Serializable

Serialized Fields

id

String id

systemPresence

String systemPresence

Class com.mypurecloud.sdk.v2.model.AgentActivityChangedTopicOutOfOffice

class AgentActivityChangedTopicOutOfOffice extends Object implements Serializable

Serialized Fields

active

Boolean active

modifiedDate

Date modifiedDate

Class com.mypurecloud.sdk.v2.model.AgentActivityChangedTopicPresence

class AgentActivityChangedTopicPresence extends Object implements Serializable

Serialized Fields

modifiedDate

Date modifiedDate

presenceDefinition

AgentActivityChangedTopicOrganizationPresence presenceDefinition

presenceMessage

String presenceMessage

Class com.mypurecloud.sdk.v2.model.AgentActivityChangedTopicRoutingStatus

class AgentActivityChangedTopicRoutingStatus extends Object implements Serializable

Serialized Fields

startTime

Date startTime

status

AgentActivityChangedTopicRoutingStatus.StatusEnum status

Class com.mypurecloud.sdk.v2.model.AgentActivityEntityListing

class AgentActivityEntityListing extends Object implements Serializable

Serialized Fields

entities

List<AgentActivity> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.AgentEvaluatorActivity

class AgentEvaluatorActivity extends Object implements Serializable

Serialized Fields

agent

User agent

averageEvaluationScore

Integer averageEvaluationScore

evaluator

User evaluator

id

String id

name

String name

numEvaluations

Integer numEvaluations

numEvaluationsWithoutViewPermission

Integer numEvaluationsWithoutViewPermission

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.AgentlessEmailSendRequestDto

class AgentlessEmailSendRequestDto extends Object implements Serializable

Serialized Fields

conversationId

String conversationId

fromAddress

EmailAddress fromAddress

htmlBody

String htmlBody

replyToAddress

EmailAddress replyToAddress

senderType

AgentlessEmailSendRequestDto.SenderTypeEnum senderType

subject

String subject

textBody

String textBody

toAddresses

List<EmailAddress> toAddresses

Class com.mypurecloud.sdk.v2.model.AgentlessEmailSendResponseDto

class AgentlessEmailSendResponseDto extends Object implements Serializable

Serialized Fields

conversationId

String conversationId

dateCreated

Date dateCreated

fromAddress

EmailAddress fromAddress

id

String id

replyToAddress

EmailAddress replyToAddress

selfUri

String selfUri

senderType

AgentlessEmailSendResponseDto.SenderTypeEnum senderType

subject

String subject

toAddresses

List<EmailAddress> toAddresses

Class com.mypurecloud.sdk.v2.model.AgentManagementUnitReference

class AgentManagementUnitReference extends Object implements Serializable

Serialized Fields

businessUnit

BusinessUnitReference businessUnit

managementUnit

ManagementUnitReference managementUnit

user

UserReference user

Class com.mypurecloud.sdk.v2.model.AgentMaxUtilization

class AgentMaxUtilization extends Object implements Serializable

Serialized Fields

level

AgentMaxUtilization.LevelEnum level

utilization

Map<String,MediaUtilization> utilization

Class com.mypurecloud.sdk.v2.model.AgentOwnedMappingPreview

class AgentOwnedMappingPreview extends Object implements Serializable

Serialized Fields

agentOwnedColumn

String agentOwnedColumn

email

String email

exists

Boolean exists

isQueueMember

Boolean isQueueMember

recordCount

Integer recordCount

userId

String userId

Class com.mypurecloud.sdk.v2.model.AgentOwnedMappingPreviewListing

class AgentOwnedMappingPreviewListing extends Object implements Serializable

Serialized Fields

entities

List<AgentOwnedMappingPreview> entities

Class com.mypurecloud.sdk.v2.model.AgentOwnedRouting

class AgentOwnedRouting extends Object implements Serializable

Serialized Fields

enableAgentOwnedCallbacks

Boolean enableAgentOwnedCallbacks

maxOwnedCallbackDelayHours

Integer maxOwnedCallbackDelayHours

maxOwnedCallbackHours

Integer maxOwnedCallbackHours

Class com.mypurecloud.sdk.v2.model.AgentPossibleWorkShiftsRequest

class AgentPossibleWorkShiftsRequest extends Object implements Serializable

Serialized Fields

weekCount

Integer weekCount

weekStartDate

LocalDate weekStartDate

Class com.mypurecloud.sdk.v2.model.AgentPossibleWorkShiftsResponse

class AgentPossibleWorkShiftsResponse extends Object implements Serializable

Serialized Fields

pattern

List<Integer> pattern

schedulerIntervalLengthMinutes

Integer schedulerIntervalLengthMinutes

timeZone

String timeZone

weeklyPossibleWorkShifts

List<PossibleWorkShiftsForWeek> weeklyPossibleWorkShifts

weekStartDate

LocalDate weekStartDate

Class com.mypurecloud.sdk.v2.model.AgentQueryAdherenceExplanationsRequest

class AgentQueryAdherenceExplanationsRequest extends Object implements Serializable

Serialized Fields

endDate

Date endDate

startDate

Date startDate

Class com.mypurecloud.sdk.v2.model.AgentQueryAdherenceExplanationsResponse

class AgentQueryAdherenceExplanationsResponse extends Object implements Serializable

Serialized Fields

downloadUrl

String downloadUrl

job

AdherenceExplanationJobReference job

result

AdherenceExplanationListingAgentQueryResponse result

Class com.mypurecloud.sdk.v2.model.AgentTimeOffRequestPatch

class AgentTimeOffRequestPatch extends Object implements Serializable

Serialized Fields

markedAsRead

Boolean markedAsRead

notes

String notes

status

AgentTimeOffRequestPatch.StatusEnum status

Class com.mypurecloud.sdk.v2.model.AggregateMetricData

class AggregateMetricData extends Object implements Serializable

Serialized Fields

metric

String metric

qualifier

String qualifier

stats

StatisticalSummary stats

Class com.mypurecloud.sdk.v2.model.AggregateViewData

class AggregateViewData extends Object implements Serializable

Serialized Fields

name

String name

stats

StatisticalSummary stats

Class com.mypurecloud.sdk.v2.model.AggregationRange

class AggregationRange extends Object implements Serializable

Serialized Fields

gte

BigDecimal gte

lt

BigDecimal lt

Class com.mypurecloud.sdk.v2.model.AggregationResult

class AggregationResult extends Object implements Serializable

Serialized Fields

count

Long count

dimension

String dimension

metric

String metric

results

List<AggregationResultEntry> results

type

AggregationResult.TypeEnum type

Class com.mypurecloud.sdk.v2.model.AggregationResultEntry

class AggregationResultEntry extends Object implements Serializable

Serialized Fields

count

Long count

gte

BigDecimal gte

lt

BigDecimal lt

value

String value

Class com.mypurecloud.sdk.v2.model.AllTimePoints

class AllTimePoints extends Object implements Serializable

Serialized Fields

allTimePoints

Long allTimePoints

dateEndWorkday

LocalDate dateEndWorkday

user

UserReference user

Class com.mypurecloud.sdk.v2.model.AmazonLexRequest

class AmazonLexRequest extends Object implements Serializable

Serialized Fields

requestAttributes

Map<String,String> requestAttributes

sessionAttributes

Map<String,String> sessionAttributes

Class com.mypurecloud.sdk.v2.model.AnalyticsAgentGroup

class AnalyticsAgentGroup extends Object implements Serializable

Serialized Fields

agentGroupId

String agentGroupId

agentGroupType

AnalyticsAgentGroup.AgentGroupTypeEnum agentGroupType

Class com.mypurecloud.sdk.v2.model.AnalyticsConversation

class AnalyticsConversation extends Object implements Serializable

Serialized Fields

conferenceStart

Date conferenceStart

conversationEnd

Date conversationEnd

conversationId

String conversationId

conversationInitiator

AnalyticsConversation.ConversationInitiatorEnum conversationInitiator

conversationStart

Date conversationStart

customerParticipation

Boolean customerParticipation

divisionIds

List<String> divisionIds

evaluations

List<AnalyticsEvaluation> evaluations

externalTag

String externalTag

knowledgeBaseIds

List<String> knowledgeBaseIds

mediaStatsMinConversationMos

Double mediaStatsMinConversationMos

mediaStatsMinConversationRFactor

Double mediaStatsMinConversationRFactor

originatingDirection

AnalyticsConversation.OriginatingDirectionEnum originatingDirection

participants

List<AnalyticsParticipant> participants

resolutions

List<AnalyticsResolution> resolutions

selfServed

Boolean selfServed

surveys

List<AnalyticsSurvey> surveys

Class com.mypurecloud.sdk.v2.model.AnalyticsConversationAsyncQueryResponse

class AnalyticsConversationAsyncQueryResponse extends Object implements Serializable

Serialized Fields

conversations

List<AnalyticsConversation> conversations

cursor

String cursor

dataAvailabilityDate

Date dataAvailabilityDate

Class com.mypurecloud.sdk.v2.model.AnalyticsConversationQueryResponse

class AnalyticsConversationQueryResponse extends Object implements Serializable

Serialized Fields

aggregations

List<AggregationResult> aggregations

conversations

List<AnalyticsConversationWithoutAttributes> conversations

totalHits

Integer totalHits

Class com.mypurecloud.sdk.v2.model.AnalyticsConversationSegment

class AnalyticsConversationSegment extends Object implements Serializable

Serialized Fields

audioMuted

Boolean audioMuted

conference

Boolean conference

destinationConversationId

String destinationConversationId

destinationSessionId

String destinationSessionId

disconnectType

AnalyticsConversationSegment.DisconnectTypeEnum disconnectType

errorCode

String errorCode

groupId

String groupId

properties

List<AnalyticsProperty> properties

q850ResponseCodes

List<Long> q850ResponseCodes

queueId

String queueId

requestedLanguageId

String requestedLanguageId

requestedRoutingSkillIds

List<String> requestedRoutingSkillIds

requestedRoutingUserIds

List<String> requestedRoutingUserIds

scoredAgents

List<AnalyticsScoredAgent> scoredAgents

segmentEnd

Date segmentEnd

segmentStart

Date segmentStart

segmentType

AnalyticsConversationSegment.SegmentTypeEnum segmentType

sipResponseCodes

List<Long> sipResponseCodes

sourceConversationId

String sourceConversationId

sourceSessionId

String sourceSessionId

subject

String subject

videoMuted

Boolean videoMuted

wrapUpCode

String wrapUpCode

wrapUpNote

String wrapUpNote

wrapUpTags

List<String> wrapUpTags

Class com.mypurecloud.sdk.v2.model.AnalyticsConversationWithoutAttributes

class AnalyticsConversationWithoutAttributes extends Object implements Serializable

Serialized Fields

conferenceStart

Date conferenceStart

conversationEnd

Date conversationEnd

conversationId

String conversationId

conversationInitiator

AnalyticsConversationWithoutAttributes.ConversationInitiatorEnum conversationInitiator

conversationStart

Date conversationStart

customerParticipation

Boolean customerParticipation

divisionIds

List<String> divisionIds

evaluations

List<AnalyticsEvaluation> evaluations

externalTag

String externalTag

knowledgeBaseIds

List<String> knowledgeBaseIds

mediaStatsMinConversationMos

Double mediaStatsMinConversationMos

mediaStatsMinConversationRFactor

Double mediaStatsMinConversationRFactor

originatingDirection

AnalyticsConversationWithoutAttributes.OriginatingDirectionEnum originatingDirection

participants

List<AnalyticsParticipantWithoutAttributes> participants

resolutions

List<AnalyticsResolution> resolutions

selfServed

Boolean selfServed

surveys

List<AnalyticsSurvey> surveys

Class com.mypurecloud.sdk.v2.model.AnalyticsConversationWithoutAttributesMultiGetResponse

class AnalyticsConversationWithoutAttributesMultiGetResponse extends Object implements Serializable

Serialized Fields

conversations

List<AnalyticsConversationWithoutAttributes> conversations

Class com.mypurecloud.sdk.v2.model.AnalyticsDataRetentionResponse

class AnalyticsDataRetentionResponse extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

retentionDays

Integer retentionDays

Class com.mypurecloud.sdk.v2.model.AnalyticsEvaluation

class AnalyticsEvaluation extends Object implements Serializable

Serialized Fields

assigneeId

String assigneeId

calibrationId

String calibrationId

contextId

String contextId

deleted

Boolean deleted

evaluationId

String evaluationId

evaluationStatus

AnalyticsEvaluation.EvaluationStatusEnum evaluationStatus

evaluatorId

String evaluatorId

eventTime

Date eventTime

formId

String formId

formName

String formName

oTotalCriticalScore

Long oTotalCriticalScore

oTotalScore

Long oTotalScore

queueId

String queueId

released

Boolean released

rescored

Boolean rescored

userId

String userId

Class com.mypurecloud.sdk.v2.model.AnalyticsFlow

class AnalyticsFlow extends Object implements Serializable

Serialized Fields

endingLanguage

String endingLanguage

entryReason

String entryReason

entryType

AnalyticsFlow.EntryTypeEnum entryType

exitReason

String exitReason

flowId

String flowId

flowName

String flowName

flowType

AnalyticsFlow.FlowTypeEnum flowType

flowVersion

String flowVersion

issuedCallback

Boolean issuedCallback

outcomes

List<AnalyticsFlowOutcome> outcomes

recognitionFailureReason

String recognitionFailureReason

startingLanguage

String startingLanguage

transferTargetAddress

String transferTargetAddress

transferTargetName

String transferTargetName

transferType

String transferType

Class com.mypurecloud.sdk.v2.model.AnalyticsFlowOutcome

class AnalyticsFlowOutcome extends Object implements Serializable

Serialized Fields

flowOutcome

String flowOutcome

flowOutcomeEndTimestamp

Date flowOutcomeEndTimestamp

flowOutcomeId

String flowOutcomeId

flowOutcomeStartTimestamp

Date flowOutcomeStartTimestamp

flowOutcomeValue

String flowOutcomeValue

Class com.mypurecloud.sdk.v2.model.AnalyticsMediaEndpointStat

class AnalyticsMediaEndpointStat extends Object implements Serializable

Serialized Fields

codecs

List<String> codecs

discardedPackets

Long discardedPackets

duplicatePackets

Long duplicatePackets

eventTime

Date eventTime

invalidPackets

Long invalidPackets

maxLatencyMs

Long maxLatencyMs

minMos

Double minMos

minRFactor

Double minRFactor

overrunPackets

Long overrunPackets

receivedPackets

Long receivedPackets

underrunPackets

Long underrunPackets

Class com.mypurecloud.sdk.v2.model.AnalyticsParticipant

class AnalyticsParticipant extends Object implements Serializable

Serialized Fields

attributes

Map<String,String> attributes

externalContactId

String externalContactId

externalOrganizationId

String externalOrganizationId

flaggedReason

AnalyticsParticipant.FlaggedReasonEnum flaggedReason

participantId

String participantId

participantName

String participantName

purpose

AnalyticsParticipant.PurposeEnum purpose

sessions

List<AnalyticsSession> sessions

teamId

String teamId

userId

String userId

Class com.mypurecloud.sdk.v2.model.AnalyticsParticipantWithoutAttributes

class AnalyticsParticipantWithoutAttributes extends Object implements Serializable

Serialized Fields

externalContactId

String externalContactId

externalOrganizationId

String externalOrganizationId

flaggedReason

AnalyticsParticipantWithoutAttributes.FlaggedReasonEnum flaggedReason

participantId

String participantId

participantName

String participantName

purpose

AnalyticsParticipantWithoutAttributes.PurposeEnum purpose

sessions

List<AnalyticsSession> sessions

teamId

String teamId

userId

String userId

Class com.mypurecloud.sdk.v2.model.AnalyticsProperty

class AnalyticsProperty extends Object implements Serializable

Serialized Fields

property

String property

propertyType

AnalyticsProperty.PropertyTypeEnum propertyType

value

String value

Class com.mypurecloud.sdk.v2.model.AnalyticsProposedAgent

class AnalyticsProposedAgent extends Object implements Serializable

Serialized Fields

agentRank

Integer agentRank

proposedAgentId

String proposedAgentId

Class com.mypurecloud.sdk.v2.model.AnalyticsQueryAggregation

class AnalyticsQueryAggregation extends Object implements Serializable

Serialized Fields

dimension

String dimension

metric

String metric

ranges

List<AggregationRange> ranges

size

Integer size

type

AnalyticsQueryAggregation.TypeEnum type

Class com.mypurecloud.sdk.v2.model.AnalyticsReportingSettings

class AnalyticsReportingSettings extends Object implements Serializable

Serialized Fields

piiMaskingEnabled

Boolean piiMaskingEnabled

queueAgentAccessObfuscation

Boolean queueAgentAccessObfuscation

Class com.mypurecloud.sdk.v2.model.AnalyticsResolution

class AnalyticsResolution extends Object implements Serializable

Serialized Fields

eventTime

Date eventTime

nNextContactAvoided

Long nNextContactAvoided

queueId

String queueId

userId

String userId

Class com.mypurecloud.sdk.v2.model.AnalyticsRoutingStatusRecord

class AnalyticsRoutingStatusRecord extends Object implements Serializable

Serialized Fields

endTime

Date endTime

routingStatus

AnalyticsRoutingStatusRecord.RoutingStatusEnum routingStatus

startTime

Date startTime

Class com.mypurecloud.sdk.v2.model.AnalyticsScoredAgent

class AnalyticsScoredAgent extends Object implements Serializable

Serialized Fields

agentScore

Integer agentScore

scoredAgentId

String scoredAgentId

Class com.mypurecloud.sdk.v2.model.AnalyticsSession

class AnalyticsSession extends Object implements Serializable

Serialized Fields

activeSkillIds

List<String> activeSkillIds

acwSkipped

Boolean acwSkipped

addressFrom

String addressFrom

addressOther

String addressOther

addressSelf

String addressSelf

addressTo

String addressTo

agentAssistantId

String agentAssistantId

agentBullseyeRing

Integer agentBullseyeRing

agentGroups

List<AnalyticsAgentGroup> agentGroups

agentOwned

Boolean agentOwned

ani

String ani

assignerId

String assignerId

authenticated

Boolean authenticated

bargedParticipantId

String bargedParticipantId

bcc

List<String> bcc

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Date callbackScheduledTime

callbackUserName

String callbackUserName

cc

List<String> cc

cleared

Boolean cleared

coachedParticipantId

String coachedParticipantId

cobrowseRole

String cobrowseRole

cobrowseRoomId

String cobrowseRoomId

deliveryStatus

AnalyticsSession.DeliveryStatusEnum deliveryStatus

deliveryStatusChangeDate

Date deliveryStatusChangeDate

destinationAddresses

List<String> destinationAddresses

direction

AnalyticsSession.DirectionEnum direction

dispositionAnalyzer

String dispositionAnalyzer

dispositionName

String dispositionName

dnis

String dnis

edgeId

String edgeId

eligibleAgentCounts

List<Integer> eligibleAgentCounts

extendedDeliveryStatus

String extendedDeliveryStatus

flow

AnalyticsFlow flow

flowInType

String flowInType

flowOutType

String flowOutType

journeyActionId

String journeyActionId

journeyActionMapId

String journeyActionMapId

journeyActionMapVersion

Integer journeyActionMapVersion

journeyCustomerId

String journeyCustomerId

journeyCustomerIdType

String journeyCustomerIdType

journeyCustomerSessionId

String journeyCustomerSessionId

journeyCustomerSessionIdType

String journeyCustomerSessionIdType

mediaBridgeId

String mediaBridgeId

mediaCount

Integer mediaCount

mediaEndpointStats

List<AnalyticsMediaEndpointStat> mediaEndpointStats

mediaType

AnalyticsSession.MediaTypeEnum mediaType

messageType

String messageType

metrics

List<AnalyticsSessionMetric> metrics

monitoredParticipantId

String monitoredParticipantId

outboundCampaignId

String outboundCampaignId

outboundContactId

String outboundContactId

outboundContactListId

String outboundContactListId

peerId

String peerId

proposedAgents

List<AnalyticsProposedAgent> proposedAgents

protocolCallId

String protocolCallId

provider

String provider

recording

Boolean recording

remote

String remote

remoteNameDisplayable

String remoteNameDisplayable

removedSkillIds

List<String> removedSkillIds

requestedRoutings

List<AnalyticsSession.RequestedRoutingsEnum> requestedRoutings

roomId

String roomId

routingRing

Integer routingRing

screenShareAddressSelf

String screenShareAddressSelf

screenShareRoomId

String screenShareRoomId

scriptId

String scriptId

segments

List<AnalyticsConversationSegment> segments

selectedAgentId

String selectedAgentId

selectedAgentRank

Integer selectedAgentRank

sessionDnis

String sessionDnis

sessionId

String sessionId

sharingScreen

Boolean sharingScreen

skipEnabled

Boolean skipEnabled

timeoutSeconds

Integer timeoutSeconds

usedRouting

AnalyticsSession.UsedRoutingEnum usedRouting

videoAddressSelf

String videoAddressSelf

videoRoomId

String videoRoomId

waitingInteractionCounts

List<Integer> waitingInteractionCounts

Class com.mypurecloud.sdk.v2.model.AnalyticsSessionMetric

class AnalyticsSessionMetric extends Object implements Serializable

Serialized Fields

emitDate

Date emitDate

name

String name

value

Long value

Class com.mypurecloud.sdk.v2.model.AnalyticsSurvey

class AnalyticsSurvey extends Object implements Serializable

Serialized Fields

eventTime

Date eventTime

oSurveyTotalScore

Long oSurveyTotalScore

queueId

String queueId

surveyCompletedDate

Date surveyCompletedDate

surveyFormContextId

String surveyFormContextId

surveyFormId

String surveyFormId

surveyFormName

String surveyFormName

surveyId

String surveyId

surveyPromoterScore

Integer surveyPromoterScore

surveyStatus

String surveyStatus

userId

String userId

Class com.mypurecloud.sdk.v2.model.AnalyticsUserDetail

class AnalyticsUserDetail extends Object implements Serializable

Serialized Fields

primaryPresence

List<AnalyticsUserPresenceRecord> primaryPresence

routingStatus

List<AnalyticsRoutingStatusRecord> routingStatus

userId

String userId

Class com.mypurecloud.sdk.v2.model.AnalyticsUserDetailsAsyncQueryResponse

class AnalyticsUserDetailsAsyncQueryResponse extends Object implements Serializable

Serialized Fields

cursor

String cursor

dataAvailabilityDate

Date dataAvailabilityDate

userDetails

List<AnalyticsUserDetail> userDetails

Class com.mypurecloud.sdk.v2.model.AnalyticsUserDetailsQueryResponse

class AnalyticsUserDetailsQueryResponse extends Object implements Serializable

Serialized Fields

aggregations

List<AggregationResult> aggregations

totalHits

Integer totalHits

userDetails

List<AnalyticsUserDetail> userDetails

Class com.mypurecloud.sdk.v2.model.AnalyticsUserPresenceRecord

class AnalyticsUserPresenceRecord extends Object implements Serializable

Serialized Fields

endTime

Date endTime

organizationPresenceId

String organizationPresenceId

startTime

Date startTime

systemPresence

AnalyticsUserPresenceRecord.SystemPresenceEnum systemPresence

Class com.mypurecloud.sdk.v2.model.Annotation

class Annotation extends Object implements Serializable

Serialized Fields

absoluteDurationMs

Long absoluteDurationMs

absoluteLocation

Long absoluteLocation

description

String description

durationMs

Long durationMs

id

String id

location

Long location

name

String name

recordingDurationMs

Long recordingDurationMs

recordingLocation

Long recordingLocation

selfUri

String selfUri

type

String type

user

User user

Class com.mypurecloud.sdk.v2.model.AnswerOption

class AnswerOption extends Object implements Serializable

Serialized Fields

assistanceConditions

List<AssistanceCondition> assistanceConditions

id

String id

text

String text

value

Integer value

Class com.mypurecloud.sdk.v2.model.ApiUsageClientQuery

class ApiUsageClientQuery extends Object implements Serializable

Serialized Fields

granularity

ApiUsageClientQuery.GranularityEnum granularity

groupBy

List<ApiUsageClientQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<ApiUsageClientQuery.MetricsEnum> metrics

Class com.mypurecloud.sdk.v2.model.ApiUsageOrganizationQuery

class ApiUsageOrganizationQuery extends Object implements Serializable

Serialized Fields

granularity

ApiUsageOrganizationQuery.GranularityEnum granularity

groupBy

List<ApiUsageOrganizationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<ApiUsageOrganizationQuery.MetricsEnum> metrics

Class com.mypurecloud.sdk.v2.model.ApiUsageQueryResult

class ApiUsageQueryResult extends Object implements Serializable

Serialized Fields

queryStatus

ApiUsageQueryResult.QueryStatusEnum queryStatus

results

List<ApiUsageRow> results

Class com.mypurecloud.sdk.v2.model.ApiUsageRow

class ApiUsageRow extends Object implements Serializable

Serialized Fields

clientId

String clientId

clientName

String clientName

date

Date date

httpMethod

String httpMethod

organizationId

String organizationId

requests

Long requests

status200

Long status200

status300

Long status300

status400

Long status400

status429

Long status429

status500

Long status500

templateUri

String templateUri

userId

String userId

Class com.mypurecloud.sdk.v2.model.ApiUsageSimpleSearch

class ApiUsageSimpleSearch extends Object implements Serializable

Serialized Fields

httpMethods

List<String> httpMethods

interval

String interval

metrics

List<ApiUsageSimpleSearch.MetricsEnum> metrics

oauthClientNames

List<String> oauthClientNames

templateUris

List<String> templateUris

Class com.mypurecloud.sdk.v2.model.AppendToDncActionSettings

class AppendToDncActionSettings extends Object implements Serializable

Serialized Fields

expirationDuration

String expirationDuration

expire

Boolean expire

listType

AppendToDncActionSettings.ListTypeEnum listType

Class com.mypurecloud.sdk.v2.model.AppEvent

class AppEvent extends Object implements Serializable

Serialized Fields

app

JourneyApp app

attributes

Map<String,CustomEventAttribute> attributes

device

Device device

eventName

String eventName

geolocation

JourneyGeolocation geolocation

ipAddress

String ipAddress

ipOrganization

String ipOrganization

mktCampaign

JourneyCampaign mktCampaign

networkConnectivity

NetworkConnectivity networkConnectivity

screenName

String screenName

sdkLibrary

SdkLibrary sdkLibrary

searchQuery

String searchQuery

traits

Map<String,CustomEventAttribute> traits

Class com.mypurecloud.sdk.v2.model.ApprovalNamespace

class ApprovalNamespace extends Object implements Serializable

Serialized Fields

namespace

ApprovalNamespace.NamespaceEnum namespace

status

ApprovalNamespace.StatusEnum status

type

ApprovalNamespace.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ArchitectDependencyTrackingBuildNotificationClient

class ArchitectDependencyTrackingBuildNotificationClient extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ArchitectDependencyTrackingBuildNotificationDependencyTrackingBuildNotification

class ArchitectDependencyTrackingBuildNotificationDependencyTrackingBuildNotification extends Object implements Serializable

Serialized Fields

client

ArchitectDependencyTrackingBuildNotificationClient client

startTime

Date startTime

status

String status

user

ArchitectDependencyTrackingBuildNotificationUser user

Class com.mypurecloud.sdk.v2.model.ArchitectDependencyTrackingBuildNotificationHomeOrganization

class ArchitectDependencyTrackingBuildNotificationHomeOrganization extends Object implements Serializable

Serialized Fields

id

String id

name

String name

thirdPartyOrgName

String thirdPartyOrgName

Class com.mypurecloud.sdk.v2.model.ArchitectDependencyTrackingBuildNotificationUser

class ArchitectDependencyTrackingBuildNotificationUser extends Object implements Serializable

Serialized Fields

homeOrg

ArchitectDependencyTrackingBuildNotificationHomeOrganization homeOrg

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ArchitectFlowFields

class ArchitectFlowFields extends Object implements Serializable

Serialized Fields

architectFlow

AddressableEntityRef architectFlow

flowRequestMappings

List<RequestMapping> flowRequestMappings

Class com.mypurecloud.sdk.v2.model.ArchitectFlowNotificationArchitectOperation

class ArchitectFlowNotificationArchitectOperation extends Object implements Serializable

Serialized Fields

actionName

ArchitectFlowNotificationArchitectOperation.ActionNameEnum actionName

actionStatus

ArchitectFlowNotificationArchitectOperation.ActionStatusEnum actionStatus

client

ArchitectFlowNotificationClient client

complete

Boolean complete

errorCode

String errorCode

errorDetails

List<ArchitectFlowNotificationErrorDetail> errorDetails

errorMessage

String errorMessage

errorMessageParams

ArchitectFlowNotificationErrorMessageParams errorMessageParams

id

String id

user

ArchitectFlowNotificationUser user

Class com.mypurecloud.sdk.v2.model.ArchitectFlowNotificationClient

class ArchitectFlowNotificationClient extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ArchitectFlowNotificationErrorDetail

class ArchitectFlowNotificationErrorDetail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.ArchitectFlowNotificationErrorMessageParams

class ArchitectFlowNotificationErrorMessageParams extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,String> additionalProperties

Class com.mypurecloud.sdk.v2.model.ArchitectFlowNotificationFlowNotification

class ArchitectFlowNotificationFlowNotification extends Object implements Serializable

Serialized Fields

checkedInVersion

ArchitectFlowNotificationFlowVersion checkedInVersion

currentOperation

ArchitectFlowNotificationArchitectOperation currentOperation

deleted

Boolean deleted

description

String description

id

String id

name

String name

publishedVersion

ArchitectFlowNotificationFlowVersion publishedVersion

savedVersion

ArchitectFlowNotificationFlowVersion savedVersion

Class com.mypurecloud.sdk.v2.model.ArchitectFlowNotificationFlowVersion

class ArchitectFlowNotificationFlowVersion extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.ArchitectFlowNotificationHomeOrganization

class ArchitectFlowNotificationHomeOrganization extends Object implements Serializable

Serialized Fields

id

String id

name

String name

thirdPartyOrgName

String thirdPartyOrgName

Class com.mypurecloud.sdk.v2.model.ArchitectFlowNotificationUser

class ArchitectFlowNotificationUser extends Object implements Serializable

Serialized Fields

homeOrg

ArchitectFlowNotificationHomeOrganization homeOrg

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ArchitectFlowOutcomeNotificationArchitectOperation

class ArchitectFlowOutcomeNotificationArchitectOperation extends Object implements Serializable

Serialized Fields

actionName

ArchitectFlowOutcomeNotificationArchitectOperation.ActionNameEnum actionName

actionStatus

ArchitectFlowOutcomeNotificationArchitectOperation.ActionStatusEnum actionStatus

client

ArchitectFlowOutcomeNotificationClient client

complete

Boolean complete

errorCode

String errorCode

errorDetails

List<ArchitectFlowOutcomeNotificationErrorDetail> errorDetails

errorMessage

String errorMessage

errorMessageParams

ArchitectFlowOutcomeNotificationErrorMessageParams errorMessageParams

id

String id

user

ArchitectFlowOutcomeNotificationUser user

Class com.mypurecloud.sdk.v2.model.ArchitectFlowOutcomeNotificationClient

class ArchitectFlowOutcomeNotificationClient extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ArchitectFlowOutcomeNotificationErrorDetail

class ArchitectFlowOutcomeNotificationErrorDetail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.ArchitectFlowOutcomeNotificationErrorMessageParams

class ArchitectFlowOutcomeNotificationErrorMessageParams extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,String> additionalProperties

Class com.mypurecloud.sdk.v2.model.ArchitectFlowOutcomeNotificationFlowOutcomeNotification

class ArchitectFlowOutcomeNotificationFlowOutcomeNotification extends Object implements Serializable

Serialized Fields

currentOperation

ArchitectFlowOutcomeNotificationArchitectOperation currentOperation

description

String description

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ArchitectFlowOutcomeNotificationHomeOrganization

class ArchitectFlowOutcomeNotificationHomeOrganization extends Object implements Serializable

Serialized Fields

id

String id

name

String name

thirdPartyOrgName

String thirdPartyOrgName

Class com.mypurecloud.sdk.v2.model.ArchitectFlowOutcomeNotificationUser

class ArchitectFlowOutcomeNotificationUser extends Object implements Serializable

Serialized Fields

homeOrg

ArchitectFlowOutcomeNotificationHomeOrganization homeOrg

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ArchitectJobMessage

class ArchitectJobMessage extends Object implements Serializable

Serialized Fields

dateTime

Date dateTime

text

String text

type

ArchitectJobMessage.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ArchitectJobStateResponse

class ArchitectJobStateResponse extends Object implements Serializable

Serialized Fields

command

ArchitectJobStateResponse.CommandEnum command

flow

AddressableEntityRef flow

id

String id

messages

List<ArchitectJobMessage> messages

selfUri

String selfUri

status

ArchitectJobStateResponse.StatusEnum status

Class com.mypurecloud.sdk.v2.model.ArchitectPromptNotificationArchitectOperation

class ArchitectPromptNotificationArchitectOperation extends Object implements Serializable

Serialized Fields

actionName

ArchitectPromptNotificationArchitectOperation.ActionNameEnum actionName

actionStatus

ArchitectPromptNotificationArchitectOperation.ActionStatusEnum actionStatus

client

ArchitectPromptNotificationClient client

complete

Boolean complete

errorCode

String errorCode

errorDetails

List<ArchitectPromptNotificationErrorDetail> errorDetails

errorMessage

String errorMessage

errorMessageParams

ArchitectPromptNotificationErrorMessageParams errorMessageParams

id

String id

user

ArchitectPromptNotificationUser user

Class com.mypurecloud.sdk.v2.model.ArchitectPromptNotificationClient

class ArchitectPromptNotificationClient extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ArchitectPromptNotificationErrorDetail

class ArchitectPromptNotificationErrorDetail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.ArchitectPromptNotificationErrorMessageParams

class ArchitectPromptNotificationErrorMessageParams extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,String> additionalProperties

Class com.mypurecloud.sdk.v2.model.ArchitectPromptNotificationHomeOrganization

class ArchitectPromptNotificationHomeOrganization extends Object implements Serializable

Serialized Fields

id

String id

name

String name

thirdPartyOrgName

String thirdPartyOrgName

Class com.mypurecloud.sdk.v2.model.ArchitectPromptNotificationPromptNotification

class ArchitectPromptNotificationPromptNotification extends Object implements Serializable

Serialized Fields

currentOperation

ArchitectPromptNotificationArchitectOperation currentOperation

description

String description

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ArchitectPromptNotificationUser

class ArchitectPromptNotificationUser extends Object implements Serializable

Serialized Fields

homeOrg

ArchitectPromptNotificationHomeOrganization homeOrg

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ArchitectPromptResourceNotificationPromptResourceNotification

class ArchitectPromptResourceNotificationPromptResourceNotification extends Object implements Serializable

Serialized Fields

durationSeconds

BigDecimal durationSeconds

id

String id

language

String language

mediaUri

String mediaUri

promptId

String promptId

uploadStatus

String uploadStatus

Class com.mypurecloud.sdk.v2.model.ArchitectSystemPromptResourceNotificationSystemPromptResourceNotification

class ArchitectSystemPromptResourceNotificationSystemPromptResourceNotification extends Object implements Serializable

Serialized Fields

durationSeconds

BigDecimal durationSeconds

id

String id

language

String language

mediaUri

String mediaUri

promptId

String promptId

uploadStatus

String uploadStatus

Class com.mypurecloud.sdk.v2.model.ArchiveRetention

class ArchiveRetention extends Object implements Serializable

Serialized Fields

days

Integer days

storageMedium

ArchiveRetention.StorageMediumEnum storageMedium

Class com.mypurecloud.sdk.v2.model.ArticleContent

class ArticleContent extends Object implements Serializable

Serialized Fields

body

ArticleContentBody body

Class com.mypurecloud.sdk.v2.model.ArticleContentBody

class ArticleContentBody extends Object implements Serializable

Serialized Fields

locationUrl

String locationUrl

Class com.mypurecloud.sdk.v2.model.AssessmentForm

class AssessmentForm extends Object implements Serializable

Serialized Fields

contextId

String contextId

dateModified

Date dateModified

id

String id

passPercent

Integer passPercent

published

Boolean published

questionGroups

List<AssessmentFormQuestionGroup> questionGroups

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.AssessmentFormQuestion

class AssessmentFormQuestion extends Object implements Serializable

Serialized Fields

answerOptions

List<AnswerOption> answerOptions

commentsRequired

Boolean commentsRequired

helpText

String helpText

id

String id

isCritical

Boolean isCritical

isKill

Boolean isKill

maxResponseCharacters

Integer maxResponseCharacters

naEnabled

Boolean naEnabled

text

String text

type

AssessmentFormQuestion.TypeEnum type

visibilityCondition

VisibilityCondition visibilityCondition

Class com.mypurecloud.sdk.v2.model.AssessmentFormQuestionGroup

class AssessmentFormQuestionGroup extends Object implements Serializable

Serialized Fields

defaultAnswersToHighest

Boolean defaultAnswersToHighest

defaultAnswersToNA

Boolean defaultAnswersToNA

id

String id

manualWeight

Boolean manualWeight

naEnabled

Boolean naEnabled

name

String name

questions

List<AssessmentFormQuestion> questions

selfUri

String selfUri

type

String type

visibilityCondition

VisibilityCondition visibilityCondition

weight

Float weight

Class com.mypurecloud.sdk.v2.model.AssessmentJobListing

class AssessmentJobListing extends Object implements Serializable

Serialized Fields

entities

List<BenefitAssessmentJob> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.AssessmentListing

class AssessmentListing extends Object implements Serializable

Serialized Fields

entities

List<BenefitAssessment> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.AssessmentQuestionGroupScore

class AssessmentQuestionGroupScore extends Object implements Serializable

Serialized Fields

markedNA

Boolean markedNA

maxTotalCriticalScore

Float maxTotalCriticalScore

maxTotalCriticalScoreUnweighted

Float maxTotalCriticalScoreUnweighted

maxTotalNonCriticalScore

Float maxTotalNonCriticalScore

maxTotalNonCriticalScoreUnweighted

Float maxTotalNonCriticalScoreUnweighted

maxTotalScore

Float maxTotalScore

maxTotalScoreUnweighted

Float maxTotalScoreUnweighted

questionGroupId

String questionGroupId

questionScores

List<AssessmentQuestionScore> questionScores

totalCriticalScore

Float totalCriticalScore

totalCriticalScoreUnweighted

Float totalCriticalScoreUnweighted

totalNonCriticalScore

Float totalNonCriticalScore

totalNonCriticalScoreUnweighted

Float totalNonCriticalScoreUnweighted

totalScore

Float totalScore

totalScoreUnweighted

Float totalScoreUnweighted

Class com.mypurecloud.sdk.v2.model.AssessmentQuestionScore

class AssessmentQuestionScore extends Object implements Serializable

Serialized Fields

answerId

String answerId

comments

String comments

failedKillQuestion

Boolean failedKillQuestion

freeTextAnswer

String freeTextAnswer

markedNA

Boolean markedNA

questionId

String questionId

score

Integer score

Class com.mypurecloud.sdk.v2.model.AssessmentScoringSet

class AssessmentScoringSet extends Object implements Serializable

Serialized Fields

agentComments

String agentComments

comments

String comments

failureReasons

List<AssessmentScoringSet.FailureReasonsEnum> failureReasons

isPassed

Boolean isPassed

questionGroupScores

List<AssessmentQuestionGroupScore> questionGroupScores

totalCriticalScore

Float totalCriticalScore

totalNonCriticalScore

Float totalNonCriticalScore

totalScore

Float totalScore

Class com.mypurecloud.sdk.v2.model.AssignedLearningModule

class AssignedLearningModule extends Object implements Serializable

Serialized Fields

archivalMode

AssignedLearningModule.ArchivalModeEnum archivalMode

assessmentForm

AssessmentForm assessmentForm

completionTimeInDays

Integer completionTimeInDays

coverArt

LearningModuleCoverArtResponse coverArt

createdBy

UserReference createdBy

currentAssignments

List<LearningAssignment> currentAssignments

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

externalId

String externalId

id

String id

informSteps

List<LearningModuleInformStep> informSteps

isArchived

Boolean isArchived

isPublished

Boolean isPublished

modifiedBy

UserReference modifiedBy

name

String name

reassignSummaryData

LearningModuleReassignSummary reassignSummaryData

rule

LearningModuleRule rule

selfUri

String selfUri

source

AssignedLearningModule.SourceEnum source

summaryData

LearningModuleSummary summaryData

type

AssignedLearningModule.TypeEnum type

version

Integer version

Class com.mypurecloud.sdk.v2.model.AssignedLearningModuleDomainEntityListing

class AssignedLearningModuleDomainEntityListing extends Object implements Serializable

Serialized Fields

entities

List<AssignedLearningModule> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.AssignedSegment

class AssignedSegment extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.AssignedWrapupCode

class AssignedWrapupCode extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.Assignment

class Assignment extends Object implements Serializable

Serialized Fields

assignedMembers

List<UserReference> assignedMembers

assignmentErrors

List<AssignmentError> assignmentErrors

removedMembers

List<UserReference> removedMembers

Class com.mypurecloud.sdk.v2.model.AssignmentError

class AssignmentError extends Object implements Serializable

Serialized Fields

message

String message

user

UserReference user

Class com.mypurecloud.sdk.v2.model.AssignmentValidation

class AssignmentValidation extends Object implements Serializable

Serialized Fields

invalidMemberAssignments

List<InvalidAssignment> invalidMemberAssignments

membersAlreadyAssigned

List<UserReference> membersAlreadyAssigned

membersAlreadyAssignedToOther

List<OtherProfileAssignment> membersAlreadyAssignedToOther

membersNotAssigned

List<UserReference> membersNotAssigned

Class com.mypurecloud.sdk.v2.model.AssignUsers

class AssignUsers extends Object implements Serializable

Serialized Fields

membersToAssign

List<String> membersToAssign

membersToRemove

List<String> membersToRemove

Class com.mypurecloud.sdk.v2.model.AssistanceCondition

class AssistanceCondition extends Object implements Serializable

Serialized Fields

operator

AssistanceCondition.OperatorEnum operator

topicIds

List<String> topicIds

Class com.mypurecloud.sdk.v2.model.AssociatedValueField

class AssociatedValueField extends Object implements Serializable

Serialized Fields

dataType

AssociatedValueField.DataTypeEnum dataType

name

String name

Class com.mypurecloud.sdk.v2.model.AsyncConversationQuery

class AsyncConversationQuery extends Object implements Serializable

Serialized Fields

conversationFilters

List<ConversationDetailQueryFilter> conversationFilters

evaluationFilters

List<EvaluationDetailQueryFilter> evaluationFilters

interval

String interval

limit

Integer limit

order

AsyncConversationQuery.OrderEnum order

orderBy

AsyncConversationQuery.OrderByEnum orderBy

resolutionFilters

List<ResolutionDetailQueryFilter> resolutionFilters

segmentFilters

List<SegmentDetailQueryFilter> segmentFilters

startOfDayIntervalMatching

Boolean startOfDayIntervalMatching

surveyFilters

List<SurveyDetailQueryFilter> surveyFilters

Class com.mypurecloud.sdk.v2.model.AsyncForecastOperationResult

class AsyncForecastOperationResult extends Object implements Serializable

Serialized Fields

operationId

String operationId

progress

Integer progress

result

BuShortTermForecast result

status

AsyncForecastOperationResult.StatusEnum status

Class com.mypurecloud.sdk.v2.model.AsyncIntradayResponse

class AsyncIntradayResponse extends Object implements Serializable

Serialized Fields

operationId

String operationId

result

BuIntradayResponse result

status

AsyncIntradayResponse.StatusEnum status

Class com.mypurecloud.sdk.v2.model.AsyncJob

class AsyncJob extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

state

AsyncJob.StateEnum state

Class com.mypurecloud.sdk.v2.model.AsyncQueryResponse

class AsyncQueryResponse extends Object implements Serializable

Serialized Fields

jobId

String jobId

Class com.mypurecloud.sdk.v2.model.AsyncQueryStatus

class AsyncQueryStatus extends Object implements Serializable

Serialized Fields

completionDate

Date completionDate

errorMessage

String errorMessage

expirationDate

Date expirationDate

state

AsyncQueryStatus.StateEnum state

submissionDate

Date submissionDate

Class com.mypurecloud.sdk.v2.model.AsyncUserDetailsQuery

class AsyncUserDetailsQuery extends Object implements Serializable

Serialized Fields

interval

String interval

limit

Integer limit

order

AsyncUserDetailsQuery.OrderEnum order

presenceFilters

List<PresenceDetailQueryFilter> presenceFilters

routingStatusFilters

List<RoutingStatusDetailQueryFilter> routingStatusFilters

userFilters

List<UserDetailQueryFilter> userFilters

Class com.mypurecloud.sdk.v2.model.Attachment

class Attachment extends Object implements Serializable

Serialized Fields

attachmentId

String attachmentId

contentLength

Integer contentLength

contentType

String contentType

contentUri

String contentUri

inlineImage

Boolean inlineImage

name

String name

Class com.mypurecloud.sdk.v2.model.AttemptLimits

class AttemptLimits extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

maxAttemptsPerContact

Integer maxAttemptsPerContact

maxAttemptsPerNumber

Integer maxAttemptsPerNumber

name

String name

recallEntries

Map<String,RecallEntry> recallEntries

resetPeriod

AttemptLimits.ResetPeriodEnum resetPeriod

selfUri

String selfUri

timeZoneId

String timeZoneId

version

Integer version

Class com.mypurecloud.sdk.v2.model.AttemptLimitsEntityListing

class AttemptLimitsEntityListing extends Object implements Serializable

Serialized Fields

entities

List<AttemptLimits> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.AttendanceStatus

class AttendanceStatus extends Object implements Serializable

Serialized Fields

attendanceStatusType

AttendanceStatus.AttendanceStatusTypeEnum attendanceStatusType

dateWorkday

LocalDate dateWorkday

Class com.mypurecloud.sdk.v2.model.AttendanceStatusListing

class AttendanceStatusListing extends Object implements Serializable

Serialized Fields

entities

List<AttendanceStatus> entities

Class com.mypurecloud.sdk.v2.model.Attribute

class Attribute extends Object implements Serializable

Serialized Fields

createdBy

DomainEntityRef createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

id

String id

modifiedBy

DomainEntityRef modifiedBy

name

String name

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.AttributeDetailEventTopicAttributeUpdateEvent

class AttributeDetailEventTopicAttributeUpdateEvent extends Object implements Serializable

Serialized Fields

attributes

Map<String,String> attributes

conversationExternalContactIds

List<String> conversationExternalContactIds

conversationExternalOrganizationIds

List<String> conversationExternalOrganizationIds

conversationId

String conversationId

eventTime

Integer eventTime

participantId

String participantId

Class com.mypurecloud.sdk.v2.model.AttributeFilterItem

class AttributeFilterItem extends Object implements Serializable

Serialized Fields

id

String id

operator

AttributeFilterItem.OperatorEnum operator

values

List<String> values

Class com.mypurecloud.sdk.v2.model.AtzmTimeSlot

class AtzmTimeSlot extends Object implements Serializable

Serialized Fields

earliestCallableTime

String earliestCallableTime

latestCallableTime

String latestCallableTime

Class com.mypurecloud.sdk.v2.model.AtzmTimeSlotWithTimeZone

class AtzmTimeSlotWithTimeZone extends Object implements Serializable

Serialized Fields

earliestCallableTime

String earliestCallableTime

latestCallableTime

String latestCallableTime

timeZoneId

String timeZoneId

Class com.mypurecloud.sdk.v2.model.AudioState

class AudioState extends Object implements Serializable

Serialized Fields

canHear

Boolean canHear

canSpeak

Boolean canSpeak

Class com.mypurecloud.sdk.v2.model.AudioUpdatedEvent

class AudioUpdatedEvent extends Object implements Serializable

Serialized Fields

audioState

AudioState audioState

communicationId

String communicationId

conversationId

String conversationId

eventDateTime

Date eventDateTime

eventId

String eventId

Class com.mypurecloud.sdk.v2.model.AuditChange

class AuditChange extends Object implements Serializable

Serialized Fields

entity

AuditEntityReference entity

newValues

List<String> newValues

oldValues

List<String> oldValues

property

String property

Class com.mypurecloud.sdk.v2.model.AuditEntity

class AuditEntity extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

type

String type

Class com.mypurecloud.sdk.v2.model.AuditEntityReference

class AuditEntityReference extends Object implements Serializable

Serialized Fields

action

String action

id

String id

name

String name

selfUri

String selfUri

type

AuditEntityReference.TypeEnum type

Class com.mypurecloud.sdk.v2.model.AuditFacet

class AuditFacet extends Object implements Serializable

Serialized Fields

name

String name

type

String type

Class com.mypurecloud.sdk.v2.model.AuditFilter

class AuditFilter extends Object implements Serializable

Serialized Fields

name

String name

operator

String operator

type

String type

values

List<String> values

Class com.mypurecloud.sdk.v2.model.AuditLogMessage

class AuditLogMessage extends Object implements Serializable

Serialized Fields

action

String action

application

String application

client

AddressableEntityRef client

context

Map<String,String> context

entity

DomainEntityRef entity

entityChanges

List<EntityChange> entityChanges

entityType

String entityType

eventDate

Date eventDate

id

String id

initiatingAction

InitiatingAction initiatingAction

level

AuditLogMessage.LevelEnum level

message

MessageInfo message

propertyChanges

List<PropertyChange> propertyChanges

remoteIp

List<String> remoteIp

serviceName

String serviceName

status

AuditLogMessage.StatusEnum status

transactionInitiator

Boolean transactionInitiator

user

DomainEntityRef user

userHomeOrgId

String userHomeOrgId

Class com.mypurecloud.sdk.v2.model.AuditMessage

class AuditMessage extends Object implements Serializable

Serialized Fields

action

String action

actionContext

String actionContext

application

String application

changes

List<Change> changes

correlationId

String correlationId

entity

AuditEntity entity

id

String id

level

String level

receivedTimestamp

String receivedTimestamp

serviceContext

ServiceContext serviceContext

serviceName

String serviceName

status

String status

timestamp

String timestamp

transactionId

String transactionId

transactionInitiator

Boolean transactionInitiator

user

AuditUser user

Class com.mypurecloud.sdk.v2.model.AuditQueryEntity

class AuditQueryEntity extends Object implements Serializable

Serialized Fields

actions

List<String> actions

name

String name

Class com.mypurecloud.sdk.v2.model.AuditQueryExecutionResultsResponse

class AuditQueryExecutionResultsResponse extends Object implements Serializable

Serialized Fields

cursor

String cursor

entities

List<AuditLogMessage> entities

id

String id

pageSize

Integer pageSize

Class com.mypurecloud.sdk.v2.model.AuditQueryExecutionStatusResponse

class AuditQueryExecutionStatusResponse extends Object implements Serializable

Serialized Fields

filters

List<AuditQueryFilter> filters

id

String id

interval

String interval

serviceName

String serviceName

sort

List<AuditQuerySort> sort

startDate

Date startDate

state

AuditQueryExecutionStatusResponse.StateEnum state

Class com.mypurecloud.sdk.v2.model.AuditQueryFilter

class AuditQueryFilter extends Object implements Serializable

Serialized Fields

property

AuditQueryFilter.PropertyEnum property

value

String value

Class com.mypurecloud.sdk.v2.model.AuditQueryRequest

class AuditQueryRequest extends Object implements Serializable

Serialized Fields

filters

List<AuditQueryFilter> filters

interval

String interval

serviceName

String serviceName

sort

List<AuditQuerySort> sort

Class com.mypurecloud.sdk.v2.model.AuditQueryResponse

class AuditQueryResponse extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.AuditQueryService

class AuditQueryService extends Object implements Serializable

Serialized Fields

entities

List<AuditQueryEntity> entities

name

String name

Class com.mypurecloud.sdk.v2.model.AuditQueryServiceMapping

class AuditQueryServiceMapping extends Object implements Serializable

Serialized Fields

services

List<AuditQueryService> services

Class com.mypurecloud.sdk.v2.model.AuditQuerySort

class AuditQuerySort extends Object implements Serializable

Serialized Fields

name

AuditQuerySort.NameEnum name

sortOrder

AuditQuerySort.SortOrderEnum sortOrder

Class com.mypurecloud.sdk.v2.model.AuditRealtimeQueryRequest

class AuditRealtimeQueryRequest extends Object implements Serializable

Serialized Fields

filters

List<AuditQueryFilter> filters

interval

String interval

pageNumber

Integer pageNumber

pageSize

Integer pageSize

serviceName

String serviceName

sort

List<AuditQuerySort> sort

Class com.mypurecloud.sdk.v2.model.AuditRealtimeQueryResultsResponse

class AuditRealtimeQueryResultsResponse extends Object implements Serializable

Serialized Fields

entities

List<AuditLogMessage> entities

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

total

Long total

Class com.mypurecloud.sdk.v2.model.AuditSearchResult

class AuditSearchResult extends Object implements Serializable

Serialized Fields

auditMessages

List<AuditMessage> auditMessages

facetInfo

List<FacetInfo> facetInfo

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

total

Integer total

Class com.mypurecloud.sdk.v2.model.AuditTopicAddressableEntityRef

class AuditTopicAddressableEntityRef extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.AuditTopicAuditLogMessage

class AuditTopicAuditLogMessage extends Object implements Serializable

Serialized Fields

action

AuditTopicAuditLogMessage.ActionEnum action

clientId

AuditTopicAddressableEntityRef clientId

context

Map<String,String> context

entity

AuditTopicDomainEntityRef entity

entityType

AuditTopicAuditLogMessage.EntityTypeEnum entityType

eventTime

Date eventTime

id

String id

level

String level

message

AuditTopicMessageInfo message

propertyChanges

List<AuditTopicPropertyChange> propertyChanges

remoteIp

List<String> remoteIp

serviceName

AuditTopicAuditLogMessage.ServiceNameEnum serviceName

userDisplay

String userDisplay

userHomeOrgId

String userHomeOrgId

userId

String userId

username

AuditTopicDomainEntityRef username

Class com.mypurecloud.sdk.v2.model.AuditTopicDomainEntityRef

class AuditTopicDomainEntityRef extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.AuditTopicMessageInfo

class AuditTopicMessageInfo extends Object implements Serializable

Serialized Fields

localizableMessageCode

String localizableMessageCode

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

Class com.mypurecloud.sdk.v2.model.AuditTopicPropertyChange

class AuditTopicPropertyChange extends Object implements Serializable

Serialized Fields

newValues

List<String> newValues

oldValues

List<String> oldValues

property

String property

Class com.mypurecloud.sdk.v2.model.AuditUser

class AuditUser extends Object implements Serializable

Serialized Fields

display

String display

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.AuthenticationSettings

class AuthenticationSettings extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

integrationId

String integrationId

Class com.mypurecloud.sdk.v2.model.AuthorizationSettings

class AuthorizationSettings extends Object implements Serializable

Serialized Fields

analysisDays

Integer analysisDays

analysisEnabled

Boolean analysisEnabled

dateLastActive

LocalDate dateLastActive

dateLastCalculated

Date dateLastCalculated

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.AuthzDivision

class AuthzDivision extends Object implements Serializable

Serialized Fields

description

String description

homeDivision

Boolean homeDivision

id

String id

name

String name

objectCounts

Map<String,Long> objectCounts

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.AuthzDivisionEntityListing

class AuthzDivisionEntityListing extends Object implements Serializable

Serialized Fields

entities

List<AuthzDivision> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.AuthzDivisionGrantEntityListing

class AuthzDivisionGrantEntityListing extends Object implements Serializable

Serialized Fields

entities

List<AuthzGrant> entities

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

total

Long total

Class com.mypurecloud.sdk.v2.model.AuthzGrant

class AuthzGrant extends Object implements Serializable

Serialized Fields

division

AuthzDivision division

grantMadeAt

Date grantMadeAt

role

AuthzGrantRole role

subjectId

String subjectId

Class com.mypurecloud.sdk.v2.model.AuthzGrantPolicy

class AuthzGrantPolicy extends Object implements Serializable

Serialized Fields

actions

List<String> actions

condition

String condition

domain

String domain

entityName

String entityName

Class com.mypurecloud.sdk.v2.model.AuthzGrantRole

class AuthzGrantRole extends Object implements Serializable

Serialized Fields

_default

Boolean _default

description

String description

id

String id

name

String name

policies

List<AuthzGrantPolicy> policies

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.AuthzSubject

class AuthzSubject extends Object implements Serializable

Serialized Fields

grants

List<AuthzGrant> grants

id

String id

name

String name

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.AutomaticTimeZoneMappingSettings

class AutomaticTimeZoneMappingSettings extends Object implements Serializable

Serialized Fields

callableWindows

List<CallableWindow> callableWindows

supportedCountries

List<String> supportedCountries

Class com.mypurecloud.sdk.v2.model.AutoStart

class AutoStart extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

Class com.mypurecloud.sdk.v2.model.AutoStatusTransitionDetail

class AutoStatusTransitionDetail extends Object implements Serializable

Serialized Fields

dateOfTransition

Date dateOfTransition

nextStatus

WorkitemStatusReference nextStatus

Class com.mypurecloud.sdk.v2.model.AvailableLanguageList

class AvailableLanguageList extends Object implements Serializable

Serialized Fields

languages

List<String> languages

Class com.mypurecloud.sdk.v2.model.AvailableMediaType

class AvailableMediaType extends Object implements Serializable

Serialized Fields

availableSubTypes

List<String> availableSubTypes

mediaType

String mediaType

Class com.mypurecloud.sdk.v2.model.AvailableMediaTypeEntityListing

class AvailableMediaTypeEntityListing extends Object implements Serializable

Serialized Fields

entities

List<AvailableMediaType> entities

Class com.mypurecloud.sdk.v2.model.AvailableTime

class AvailableTime extends Object implements Serializable

Serialized Fields

activityCategory

AvailableTime.ActivityCategoryEnum activityCategory

dateStart

Date dateStart

isPaid

Boolean isPaid

lengthInMinutes

Integer lengthInMinutes

wfmSchedule

WfmScheduleReference wfmSchedule

Class com.mypurecloud.sdk.v2.model.AvailableTimeOffRange

class AvailableTimeOffRange extends Object implements Serializable

Serialized Fields

availableMinutesPerInterval

List<Integer> availableMinutesPerInterval

granularity

AvailableTimeOffRange.GranularityEnum granularity

startDate

LocalDate startDate

timeOffLimit

TimeOffLimitReference timeOffLimit

waitlistedRequestsPerInterval

List<Integer> waitlistedRequestsPerInterval

waitlistEnabled

Boolean waitlistEnabled

Class com.mypurecloud.sdk.v2.model.AvailableTimeOffRequest

class AvailableTimeOffRequest extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

dateRanges

List<LocalDateRange> dateRanges

Class com.mypurecloud.sdk.v2.model.AvailableTimeOffResponse

class AvailableTimeOffResponse extends Object implements Serializable

Serialized Fields

values

List<AvailableTimeOffRange> values

Class com.mypurecloud.sdk.v2.model.AvailableTopic

class AvailableTopic extends Object implements Serializable

Serialized Fields

description

String description

enforced

Boolean enforced

id

String id

permissionDetails

List<PermissionDetails> permissionDetails

publicApiTemplateUriPaths

List<String> publicApiTemplateUriPaths

requiresAnyValidator

Boolean requiresAnyValidator

requiresCurrentUser

Boolean requiresCurrentUser

requiresCurrentUserOrPermission

Boolean requiresCurrentUserOrPermission

requiresDivisionPermissions

Boolean requiresDivisionPermissions

requiresPermissions

List<String> requiresPermissions

schema

Map<String,Object> schema

topicParameters

List<String> topicParameters

transports

List<AvailableTopic.TransportsEnum> transports

visibility

AvailableTopic.VisibilityEnum visibility

Class com.mypurecloud.sdk.v2.model.AvailableTopicEntityListing

class AvailableTopicEntityListing extends Object implements Serializable

Serialized Fields

entities

List<AvailableTopic> entities

Class com.mypurecloud.sdk.v2.model.AvailableTranslations

class AvailableTranslations extends Object implements Serializable

Serialized Fields

builtin

List<String> builtin

orgSpecific

List<String> orgSpecific

Class com.mypurecloud.sdk.v2.model.BaseMediaSettings

class BaseMediaSettings extends Object implements Serializable

Serialized Fields

enableAutoAnswer

Boolean enableAutoAnswer

Class com.mypurecloud.sdk.v2.model.BaseProgramEntity

class BaseProgramEntity extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.BaseTopicEntitiy

class BaseTopicEntitiy extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.BatchConversationEventRequest

class BatchConversationEventRequest extends Object implements Serializable

Serialized Fields

audioUpdatedEvents

List<AudioUpdatedEvent> audioUpdatedEvents

communicationAnsweredEvents

List<CommunicationAnsweredEvent> communicationAnsweredEvents

communicationDispositionAppliedEvents

List<CommunicationDispositionAppliedEvent> communicationDispositionAppliedEvents

communicationEndedEvents

List<CommunicationEndedEvent> communicationEndedEvents

consultTransferEvents

List<ConsultTransferEvent> consultTransferEvents

endConsultTransferEvents

List<EndConsultTransferEvent> endConsultTransferEvents

endTransferEvents

List<EndTransferEvent> endTransferEvents

externalEstablishedEvents

List<ExternalEstablishedEvent> externalEstablishedEvents

holdUpdatedEvents

List<HoldUpdatedEvent> holdUpdatedEvents

ivrEstablishedEvents

List<IvrEstablishedEvent> ivrEstablishedEvents

phoneEstablishedEvents

List<PhoneEstablishedEvent> phoneEstablishedEvents

phoneTransferEvents

List<PhoneTransferEvent> phoneTransferEvents

progressConsultTransferEvents

List<ProgressConsultTransferEvent> progressConsultTransferEvents

progressTransferEvents

List<ProgressTransferEvent> progressTransferEvents

routingEstablishedEvents

List<RoutingEstablishedEvent> routingEstablishedEvents

routingTransferEvents

List<RoutingTransferEvent> routingTransferEvents

userEstablishedEvents

List<UserEstablishedEvent> userEstablishedEvents

userTransferEvents

List<UserTransferEvent> userTransferEvents

Class com.mypurecloud.sdk.v2.model.BatchDownloadJobResult

class BatchDownloadJobResult extends Object implements Serializable

Serialized Fields

contentType

String contentType

conversationId

String conversationId

errorMsg

String errorMsg

id

String id

name

String name

recordingId

String recordingId

resultUrl

String resultUrl

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.BatchDownloadJobStatusResult

class BatchDownloadJobStatusResult extends Object implements Serializable

Serialized Fields

errorCount

Integer errorCount

expectedResultCount

Integer expectedResultCount

id

String id

jobId

String jobId

resultCount

Integer resultCount

results

List<BatchDownloadJobResult> results

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.BatchDownloadJobSubmission

class BatchDownloadJobSubmission extends Object implements Serializable

Serialized Fields

batchDownloadRequestList

List<BatchDownloadRequest> batchDownloadRequestList

Class com.mypurecloud.sdk.v2.model.BatchDownloadJobSubmissionResult

class BatchDownloadJobSubmissionResult extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.BatchDownloadRequest

class BatchDownloadRequest extends Object implements Serializable

Serialized Fields

conversationId

String conversationId

recordingId

String recordingId

Class com.mypurecloud.sdk.v2.model.BatchEventResponse

class BatchEventResponse extends Object implements Serializable

Serialized Fields

errors

List<EventError> errors

Class com.mypurecloud.sdk.v2.model.BatchUserPresenceEventRequest

class BatchUserPresenceEventRequest extends Object implements Serializable

Serialized Fields

userPresenceEvents

List<UserPresenceEvent> userPresenceEvents

Class com.mypurecloud.sdk.v2.model.BatchUserRoutingStatusEventRequest

class BatchUserRoutingStatusEventRequest extends Object implements Serializable

Serialized Fields

userRoutingStatusEvents

List<UserRoutingStatusEvent> userRoutingStatusEvents

Class com.mypurecloud.sdk.v2.model.BenefitAssessment

class BenefitAssessment extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

kpiAssessments

List<KeyPerformanceIndicatorAssessment> kpiAssessments

queues

List<AddressableEntityRef> queues

selfUri

String selfUri

state

BenefitAssessment.StateEnum state

Class com.mypurecloud.sdk.v2.model.BenefitAssessmentJob

class BenefitAssessmentJob extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

selfUri

String selfUri

state

BenefitAssessmentJob.StateEnum state

Class com.mypurecloud.sdk.v2.model.BillingUsage

class BillingUsage extends Object implements Serializable

Serialized Fields

name

String name

resources

List<BillingUsageResource> resources

totalUsage

String totalUsage

Class com.mypurecloud.sdk.v2.model.BillingUsageReport

class BillingUsageReport extends Object implements Serializable

Serialized Fields

endDate

Date endDate

id

String id

name

String name

selfUri

String selfUri

startDate

Date startDate

status

BillingUsageReport.StatusEnum status

usages

List<BillingUsage> usages

Class com.mypurecloud.sdk.v2.model.BillingUsageResource

class BillingUsageResource extends Object implements Serializable

Serialized Fields

date

Date date

name

String name

Class com.mypurecloud.sdk.v2.model.Biography

class Biography extends Object implements Serializable

Serialized Fields

biography

String biography

education

List<Education> education

hobbies

List<String> hobbies

interests

List<String> interests

spouse

String spouse

Class com.mypurecloud.sdk.v2.model.BotAggregateDataContainer

class BotAggregateDataContainer extends Object implements Serializable

Serialized Fields

data

List<StatisticalResponse> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.BotAggregateQueryClause

class BotAggregateQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<BotAggregateQueryPredicate> predicates

type

BotAggregateQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.BotAggregateQueryFilter

class BotAggregateQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<BotAggregateQueryClause> clauses

predicates

List<BotAggregateQueryPredicate> predicates

type

BotAggregateQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.BotAggregateQueryPredicate

class BotAggregateQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

BotAggregateQueryPredicate.DimensionEnum dimension

operator

BotAggregateQueryPredicate.OperatorEnum operator

range

NumericRange range

type

BotAggregateQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.BotAggregateQueryResponse

class BotAggregateQueryResponse extends Object implements Serializable

Serialized Fields

results

List<BotAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.BotAggregationQuery

class BotAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

BotAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

BotAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<BotAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<BotAggregationQuery.MetricsEnum> metrics

timeZone

String timeZone

views

List<BotAggregationView> views

Class com.mypurecloud.sdk.v2.model.BotAggregationView

class BotAggregationView extends Object implements Serializable

Serialized Fields

function

BotAggregationView.FunctionEnum function

name

String name

range

AggregationRange range

target

BotAggregationView.TargetEnum target

Class com.mypurecloud.sdk.v2.model.BotAsyncAggregateQueryResponse

class BotAsyncAggregateQueryResponse extends Object implements Serializable

Serialized Fields

cursor

String cursor

results

List<BotAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.BotAsyncAggregationQuery

class BotAsyncAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

BotAsyncAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

BotAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<BotAsyncAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<BotAsyncAggregationQuery.MetricsEnum> metrics

pageSize

Integer pageSize

timeZone

String timeZone

views

List<BotAggregationView> views

Class com.mypurecloud.sdk.v2.model.BotConnectorBot

class BotConnectorBot extends Object implements Serializable

Serialized Fields

botCompositeTag

String botCompositeTag

description

String description

id

String id

name

String name

selfUri

String selfUri

versions

List<BotConnectorBotVersion> versions

Class com.mypurecloud.sdk.v2.model.BotConnectorBotSummaryEntityListing

class BotConnectorBotSummaryEntityListing extends Object implements Serializable

Serialized Fields

entities

List<BotSummary> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.BotConnectorBotVersion

class BotConnectorBotVersion extends Object implements Serializable

Serialized Fields

intents

List<BotIntent> intents

supportedLanguages

List<String> supportedLanguages

version

String version

Class com.mypurecloud.sdk.v2.model.BotConnectorBotVersionSummaryEntityListing

class BotConnectorBotVersionSummaryEntityListing extends Object implements Serializable

Serialized Fields

entities

List<BotVersionSummary> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.BotExecutionConfiguration

class BotExecutionConfiguration extends Object implements Serializable

Serialized Fields

botCredentials

NuanceBotCredentials botCredentials

botId

String botId

executionHost

String executionHost

Class com.mypurecloud.sdk.v2.model.BotIntent

class BotIntent extends Object implements Serializable

Serialized Fields

name

String name

slots

Map<String,BotSlot> slots

Class com.mypurecloud.sdk.v2.model.BotList

class BotList extends Object implements Serializable

Serialized Fields

chatBots

List<BotConnectorBot> chatBots

Class com.mypurecloud.sdk.v2.model.BotMessengerProfile

class BotMessengerProfile extends Object implements Serializable

Serialized Fields

avatarUrl

String avatarUrl

name

String name

Class com.mypurecloud.sdk.v2.model.BotSearchResponse

class BotSearchResponse extends Object implements Serializable

Serialized Fields

botType

BotSearchResponse.BotTypeEnum botType

description

String description

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.BotSearchResponseEntityListing

class BotSearchResponseEntityListing extends Object implements Serializable

Serialized Fields

entities

List<BotSearchResponse> entities

Class com.mypurecloud.sdk.v2.model.BotSlot

class BotSlot extends Object implements Serializable

Serialized Fields

name

String name

type

String type

Class com.mypurecloud.sdk.v2.model.BotSummary

class BotSummary extends Object implements Serializable

Serialized Fields

botCompositeTag

String botCompositeTag

description

String description

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.BotVersionSummary

class BotVersionSummary extends Object implements Serializable

Serialized Fields

botCompositeTag

String botCompositeTag

description

String description

id

String id

name

String name

version

String version

Class com.mypurecloud.sdk.v2.model.Browser

class Browser extends Object implements Serializable

Serialized Fields

family

String family

featuresFlash

Boolean featuresFlash

featuresJava

Boolean featuresJava

featuresPdf

Boolean featuresPdf

featuresWebrtc

Boolean featuresWebrtc

fingerprint

String fingerprint

isMobile

Boolean isMobile

lang

String lang

version

String version

viewHeight

Integer viewHeight

viewWidth

Integer viewWidth

Class com.mypurecloud.sdk.v2.model.BuAbandonRate

class BuAbandonRate extends Object implements Serializable

Serialized Fields

include

Boolean include

percent

Integer percent

Class com.mypurecloud.sdk.v2.model.BuAgentScheduleActivity

class BuAgentScheduleActivity extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

description

String description

externalActivityId

String externalActivityId

externalActivityType

BuAgentScheduleActivity.ExternalActivityTypeEnum externalActivityType

lengthMinutes

Integer lengthMinutes

paid

Boolean paid

startDate

Date startDate

timeOffRequestId

String timeOffRequestId

Class com.mypurecloud.sdk.v2.model.BuAgentScheduleHistoryChange

class BuAgentScheduleHistoryChange extends Object implements Serializable

Serialized Fields

deletes

BuAgentScheduleHistoryDeletedChange deletes

fullDayTimeOffMarkers

List<BuFullDayTimeOffMarker> fullDayTimeOffMarkers

metadata

BuAgentScheduleHistoryChangeMetadata metadata

shifts

List<BuAgentScheduleShift> shifts

Class com.mypurecloud.sdk.v2.model.BuAgentScheduleHistoryChangeMetadata

class BuAgentScheduleHistoryChangeMetadata extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

modifiedBy

UserReference modifiedBy

Class com.mypurecloud.sdk.v2.model.BuAgentScheduleHistoryDeletedChange

class BuAgentScheduleHistoryDeletedChange extends Object implements Serializable

Serialized Fields

agentSchedule

Boolean agentSchedule

fullDayTimeOffMarkerDates

List<LocalDate> fullDayTimeOffMarkerDates

shiftIds

List<String> shiftIds

Class com.mypurecloud.sdk.v2.model.BuAgentScheduleHistoryDroppedChange

class BuAgentScheduleHistoryDroppedChange extends Object implements Serializable

Serialized Fields

deletes

BuAgentScheduleHistoryDeletedChange deletes

fullDayTimeOffMarkerDates

List<LocalDate> fullDayTimeOffMarkerDates

metadata

BuAgentScheduleHistoryChangeMetadata metadata

shiftIds

List<String> shiftIds

Class com.mypurecloud.sdk.v2.model.BuAgentScheduleHistoryResponse

class BuAgentScheduleHistoryResponse extends Object implements Serializable

Serialized Fields

basePublishedSchedule

BuAgentScheduleHistoryChange basePublishedSchedule

changes

List<BuAgentScheduleHistoryChange> changes

droppedChanges

List<BuAgentScheduleHistoryDroppedChange> droppedChanges

priorPublishedSchedules

List<BuScheduleReference> priorPublishedSchedules

Class com.mypurecloud.sdk.v2.model.BuAgentSchedulePublishedScheduleReference

class BuAgentSchedulePublishedScheduleReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

weekCount

Integer weekCount

weekDate

LocalDate weekDate

Class com.mypurecloud.sdk.v2.model.BuAgentScheduleQueryResponse

class BuAgentScheduleQueryResponse extends Object implements Serializable

Serialized Fields

fullDayTimeOffMarkers

List<BuFullDayTimeOffMarker> fullDayTimeOffMarkers

metadata

WfmVersionedEntityMetadata metadata

shifts

List<BuAgentScheduleShift> shifts

user

UserReference user

workPlan

WorkPlanReference workPlan

workPlansPerWeek

List<WorkPlanReference> workPlansPerWeek

Class com.mypurecloud.sdk.v2.model.BuAgentScheduleRescheduleResponse

class BuAgentScheduleRescheduleResponse extends Object implements Serializable

Serialized Fields

fullDayTimeOffMarkers

List<BuFullDayTimeOffMarker> fullDayTimeOffMarkers

shifts

List<BuAgentScheduleShift> shifts

user

UserReference user

workPlan

WorkPlanReference workPlan

workPlansPerWeek

List<WorkPlanReference> workPlansPerWeek

Class com.mypurecloud.sdk.v2.model.BuAgentScheduleSearchResponse

class BuAgentScheduleSearchResponse extends Object implements Serializable

Serialized Fields

fullDayTimeOffMarkers

List<BuFullDayTimeOffMarker> fullDayTimeOffMarkers

shifts

List<BuAgentScheduleShift> shifts

user

UserReference user

Class com.mypurecloud.sdk.v2.model.BuAgentScheduleShift

class BuAgentScheduleShift extends Object implements Serializable

Serialized Fields

activities

List<BuAgentScheduleActivity> activities

id

String id

lengthMinutes

Integer lengthMinutes

manuallyEdited

Boolean manuallyEdited

schedule

BuScheduleReference schedule

startDate

Date startDate

Class com.mypurecloud.sdk.v2.model.BuAgentSchedulesQueryResponse

class BuAgentSchedulesQueryResponse extends Object implements Serializable

Serialized Fields

agentSchedules

List<BuAgentScheduleQueryResponse> agentSchedules

businessUnitTimeZone

String businessUnitTimeZone

Class com.mypurecloud.sdk.v2.model.BuAgentSchedulesSearchResponse

class BuAgentSchedulesSearchResponse extends Object implements Serializable

Serialized Fields

agentSchedules

List<BuAgentScheduleSearchResponse> agentSchedules

businessUnitTimeZone

String businessUnitTimeZone

publishedSchedules

List<BuAgentSchedulePublishedScheduleReference> publishedSchedules

Class com.mypurecloud.sdk.v2.model.BuAgentScheduleUpdate

class BuAgentScheduleUpdate extends Object implements Serializable

Serialized Fields

shiftStartDates

List<Date> shiftStartDates

type

BuAgentScheduleUpdate.TypeEnum type

Class com.mypurecloud.sdk.v2.model.BuAsyncAgentSchedulesQueryResponse

class BuAsyncAgentSchedulesQueryResponse extends Object implements Serializable

Serialized Fields

downloadUrl

String downloadUrl

operationId

String operationId

progress

Integer progress

result

BuAgentSchedulesQueryResponse result

status

BuAsyncAgentSchedulesQueryResponse.StatusEnum status

Class com.mypurecloud.sdk.v2.model.BuAsyncAgentSchedulesSearchResponse

class BuAsyncAgentSchedulesSearchResponse extends Object implements Serializable

Serialized Fields

downloadUrl

String downloadUrl

operationId

String operationId

progress

Integer progress

result

BuAgentSchedulesSearchResponse result

status

BuAsyncAgentSchedulesSearchResponse.StatusEnum status

Class com.mypurecloud.sdk.v2.model.BuAsyncScheduleResponse

class BuAsyncScheduleResponse extends Object implements Serializable

Serialized Fields

operationId

String operationId

result

BuScheduleMetadata result

status

BuAsyncScheduleResponse.StatusEnum status

Class com.mypurecloud.sdk.v2.model.BuAsyncScheduleRunResponse

class BuAsyncScheduleRunResponse extends Object implements Serializable

Serialized Fields

operationId

String operationId

result

BuScheduleRun result

status

BuAsyncScheduleRunResponse.StatusEnum status

Class com.mypurecloud.sdk.v2.model.BuAverageSpeedOfAnswer

class BuAverageSpeedOfAnswer extends Object implements Serializable

Serialized Fields

include

Boolean include

seconds

Integer seconds

Class com.mypurecloud.sdk.v2.model.BuCopyScheduleRequest

class BuCopyScheduleRequest extends Object implements Serializable

Serialized Fields

description

String description

weekDate

LocalDate weekDate

Class com.mypurecloud.sdk.v2.model.BuCreateBlankScheduleRequest

class BuCreateBlankScheduleRequest extends Object implements Serializable

Serialized Fields

description

String description

shortTermForecast

BuShortTermForecastReference shortTermForecast

weekCount

Integer weekCount

Class com.mypurecloud.sdk.v2.model.BuCurrentAgentScheduleSearchResponse

class BuCurrentAgentScheduleSearchResponse extends Object implements Serializable

Serialized Fields

agentSchedules

List<BuAgentScheduleSearchResponse> agentSchedules

businessUnitTimeZone

String businessUnitTimeZone

endDate

Date endDate

publishedSchedules

List<BuAgentSchedulePublishedScheduleReference> publishedSchedules

startDate

Date startDate

updates

List<BuAgentScheduleUpdate> updates

Class com.mypurecloud.sdk.v2.model.BuForecastGenerationPlanningGroupResult

class BuForecastGenerationPlanningGroupResult extends Object implements Serializable

Serialized Fields

metricResults

List<BuForecastTimeSeriesResult> metricResults

planningGroupId

String planningGroupId

Class com.mypurecloud.sdk.v2.model.BuForecastGenerationResult

class BuForecastGenerationResult extends Object implements Serializable

Serialized Fields

planningGroupResults

List<BuForecastGenerationPlanningGroupResult> planningGroupResults

Class com.mypurecloud.sdk.v2.model.BuForecastModification

class BuForecastModification extends Object implements Serializable

Serialized Fields

displayGranularity

String displayGranularity

enabled

Boolean enabled

endIntervalIndex

Integer endIntervalIndex

granularity

String granularity

legacyMetric

BuForecastModification.LegacyMetricEnum legacyMetric

metric

BuForecastModification.MetricEnum metric

planningGroupIds

List<String> planningGroupIds

startIntervalIndex

Integer startIntervalIndex

type

BuForecastModification.TypeEnum type

value

Double value

values

List<WfmForecastModificationIntervalOffsetValue> values

Class com.mypurecloud.sdk.v2.model.BuForecastResult

class BuForecastResult extends Object implements Serializable

Serialized Fields

planningGroups

List<ForecastPlanningGroupData> planningGroups

referenceStartDate

Date referenceStartDate

weekCount

Integer weekCount

weekNumber

Integer weekNumber

Class com.mypurecloud.sdk.v2.model.BuForecastResultResponse

class BuForecastResultResponse extends Object implements Serializable

Serialized Fields

downloadUrl

String downloadUrl

result

BuForecastResult result

Class com.mypurecloud.sdk.v2.model.BuForecastTimeSeriesResult

class BuForecastTimeSeriesResult extends Object implements Serializable

Serialized Fields

forecastingMethod

BuForecastTimeSeriesResult.ForecastingMethodEnum forecastingMethod

forecastType

BuForecastTimeSeriesResult.ForecastTypeEnum forecastType

metric

BuForecastTimeSeriesResult.MetricEnum metric

Class com.mypurecloud.sdk.v2.model.BuFullDayTimeOffMarker

class BuFullDayTimeOffMarker extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

businessUnitDate

LocalDate businessUnitDate

description

String description

lengthMinutes

Integer lengthMinutes

paid

Boolean paid

timeOffRequestId

String timeOffRequestId

Class com.mypurecloud.sdk.v2.model.BuGenerateScheduleRequest

class BuGenerateScheduleRequest extends Object implements Serializable

Serialized Fields

description

String description

options

SchedulingOptionsRequest options

shortTermForecast

BuShortTermForecastReference shortTermForecast

weekCount

Integer weekCount

Class com.mypurecloud.sdk.v2.model.BuGetCurrentAgentScheduleRequest

class BuGetCurrentAgentScheduleRequest extends Object implements Serializable

Serialized Fields

endDate

Date endDate

startDate

Date startDate

Class com.mypurecloud.sdk.v2.model.BuHeadcountForecast

class BuHeadcountForecast extends Object implements Serializable

Serialized Fields

entities

List<BuPlanningGroupHeadcountForecast> entities

referenceStartDate

Date referenceStartDate

Class com.mypurecloud.sdk.v2.model.BuHeadcountForecastResponse

class BuHeadcountForecastResponse extends Object implements Serializable

Serialized Fields

downloadUrl

String downloadUrl

result

BuHeadcountForecast result

Class com.mypurecloud.sdk.v2.model.BuImportAgentScheduleUploadSchema

class BuImportAgentScheduleUploadSchema extends Object implements Serializable

Serialized Fields

fullDayTimeOffMarkers

List<BuFullDayTimeOffMarker> fullDayTimeOffMarkers

shifts

List<BuAgentScheduleShift> shifts

userId

String userId

workPlanId

ValueWrapperString workPlanId

workPlanIdsPerWeek

ListWrapperString workPlanIdsPerWeek

Class com.mypurecloud.sdk.v2.model.BuImportShortTermForecastSchema

class BuImportShortTermForecastSchema extends Object implements Serializable

Serialized Fields

canUseForScheduling

Boolean canUseForScheduling

description

String description

longTermPlanningGroups

List<LongTermForecastPlanningGroupData> longTermPlanningGroups

planningGroups

List<ForecastPlanningGroupData> planningGroups

weekCount

Integer weekCount

Class com.mypurecloud.sdk.v2.model.BuIntradayDataGroup

class BuIntradayDataGroup extends Object implements Serializable

Serialized Fields

forecastDataPerInterval

List<BuIntradayForecastData> forecastDataPerInterval

forecastDataSummary

BuIntradayForecastData forecastDataSummary

mediaType

BuIntradayDataGroup.MediaTypeEnum mediaType

performancePredictionDataPerInterval

List<IntradayPerformancePredictionData> performancePredictionDataPerInterval

performancePredictionDataSummary

IntradayPerformancePredictionData performancePredictionDataSummary

scheduleDataPerInterval

List<BuIntradayScheduleData> scheduleDataPerInterval

scheduleDataSummary

BuIntradayScheduleData scheduleDataSummary

Class com.mypurecloud.sdk.v2.model.BuIntradayForecastData

class BuIntradayForecastData extends Object implements Serializable

Serialized Fields

averageHandleTimeSeconds

Double averageHandleTimeSeconds

offered

Double offered

Class com.mypurecloud.sdk.v2.model.BuIntradayResponse

class BuIntradayResponse extends Object implements Serializable

Serialized Fields

categories

List<BuIntradayResponse.CategoriesEnum> categories

endDate

Date endDate

intervalLengthMinutes

Integer intervalLengthMinutes

intradayDataGroupings

List<BuIntradayDataGroup> intradayDataGroupings

noDataReason

BuIntradayResponse.NoDataReasonEnum noDataReason

schedule

BuScheduleReference schedule

shortTermForecast

BuShortTermForecastReference shortTermForecast

startDate

Date startDate

Class com.mypurecloud.sdk.v2.model.BuIntradayScheduleData

class BuIntradayScheduleData extends Object implements Serializable

Serialized Fields

onQueueTimeSeconds

Long onQueueTimeSeconds

Class com.mypurecloud.sdk.v2.model.BulkCallbackDisconnectRequest

class BulkCallbackDisconnectRequest extends Object implements Serializable

Serialized Fields

callbackDisconnectIdentifiers

List<CallbackDisconnectIdentifier> callbackDisconnectIdentifiers

Class com.mypurecloud.sdk.v2.model.BulkCallbackPatchRequest

class BulkCallbackPatchRequest extends Object implements Serializable

Serialized Fields

patchCallbackRequests

List<PatchCallbackRequest> patchCallbackRequests

Class com.mypurecloud.sdk.v2.model.BulkCallbackPatchResponse

class BulkCallbackPatchResponse extends Object implements Serializable

Serialized Fields

errorCount

Integer errorCount

errorIndexes

List<Integer> errorIndexes

results

List<BulkResult> results

Class com.mypurecloud.sdk.v2.model.BulkContactsRequest

class BulkContactsRequest extends Object implements Serializable

Serialized Fields

entities

List<ExternalContact> entities

Class com.mypurecloud.sdk.v2.model.BulkContactsResponse

class BulkContactsResponse extends Object implements Serializable

Serialized Fields

errorCount

Integer errorCount

errorIndexes

List<Integer> errorIndexes

results

List<BulkResponseResultExternalContactExternalContact> results

Class com.mypurecloud.sdk.v2.model.BulkDeleteResponse

class BulkDeleteResponse extends Object implements Serializable

Serialized Fields

errorCount

Integer errorCount

errorIndexes

List<Integer> errorIndexes

results

List<BulkResponseResultVoidEntity> results

Class com.mypurecloud.sdk.v2.model.BulkError

class BulkError extends Object implements Serializable

Serialized Fields

code

String code

message

String message

Class com.mypurecloud.sdk.v2.model.BulkErrorDetail

class BulkErrorDetail extends Object implements Serializable

Serialized Fields

fieldName

String fieldName

message

String message

value

String value

Class com.mypurecloud.sdk.v2.model.BulkErrorEntity

class BulkErrorEntity extends Object implements Serializable

Serialized Fields

code

String code

details

List<BulkErrorDetail> details

entity

Entity entity

message

String message

retryable

Boolean retryable

status

Integer status

Class com.mypurecloud.sdk.v2.model.BulkErrorExternalContact

class BulkErrorExternalContact extends Object implements Serializable

Serialized Fields

code

String code

details

List<BulkErrorDetail> details

entity

ExternalContact entity

message

String message

retryable

Boolean retryable

status

Integer status

Class com.mypurecloud.sdk.v2.model.BulkErrorExternalOrganization

class BulkErrorExternalOrganization extends Object implements Serializable

Serialized Fields

code

String code

details

List<BulkErrorDetail> details

entity

ExternalOrganization entity

message

String message

retryable

Boolean retryable

status

Integer status

Class com.mypurecloud.sdk.v2.model.BulkErrorNote

class BulkErrorNote extends Object implements Serializable

Serialized Fields

code

String code

details

List<BulkErrorDetail> details

entity

Note entity

message

String message

retryable

Boolean retryable

status

Integer status

Class com.mypurecloud.sdk.v2.model.BulkErrorRelationship

class BulkErrorRelationship extends Object implements Serializable

Serialized Fields

code

String code

details

List<BulkErrorDetail> details

entity

Relationship entity

message

String message

retryable

Boolean retryable

status

Integer status

Class com.mypurecloud.sdk.v2.model.BulkFetchContactsResponse

class BulkFetchContactsResponse extends Object implements Serializable

Serialized Fields

errorCount

Integer errorCount

errorIndexes

List<Integer> errorIndexes

results

List<BulkResponseResultExternalContactEntity> results

Class com.mypurecloud.sdk.v2.model.BulkFetchNotesResponse

class BulkFetchNotesResponse extends Object implements Serializable

Serialized Fields

errorCount

Integer errorCount

errorIndexes

List<Integer> errorIndexes

results

List<BulkResponseResultNoteEntity> results

Class com.mypurecloud.sdk.v2.model.BulkFetchOrganizationsResponse

class BulkFetchOrganizationsResponse extends Object implements Serializable

Serialized Fields

errorCount

Integer errorCount

errorIndexes

List<Integer> errorIndexes

results

List<BulkResponseResultExternalOrganizationEntity> results

Class com.mypurecloud.sdk.v2.model.BulkFetchRelationshipsResponse

class BulkFetchRelationshipsResponse extends Object implements Serializable

Serialized Fields

errorCount

Integer errorCount

errorIndexes

List<Integer> errorIndexes

results

List<BulkResponseResultRelationshipEntity> results

Class com.mypurecloud.sdk.v2.model.BulkIdsRequest

class BulkIdsRequest extends Object implements Serializable

Serialized Fields

entities

List<WritableEntity> entities

Class com.mypurecloud.sdk.v2.model.BulkNotesRequest

class BulkNotesRequest extends Object implements Serializable

Serialized Fields

entities

List<Note> entities

Class com.mypurecloud.sdk.v2.model.BulkNotesResponse

class BulkNotesResponse extends Object implements Serializable

Serialized Fields

errorCount

Integer errorCount

errorIndexes

List<Integer> errorIndexes

results

List<BulkResponseResultNoteNote> results

Class com.mypurecloud.sdk.v2.model.BulkOrganizationsRequest

class BulkOrganizationsRequest extends Object implements Serializable

Serialized Fields

entities

List<ExternalOrganization> entities

Class com.mypurecloud.sdk.v2.model.BulkOrganizationsResponse

class BulkOrganizationsResponse extends Object implements Serializable

Serialized Fields

errorCount

Integer errorCount

errorIndexes

List<Integer> errorIndexes

results

List<BulkResponseResultExternalOrganizationExternalOrganization> results

Class com.mypurecloud.sdk.v2.model.BulkRelationshipsRequest

class BulkRelationshipsRequest extends Object implements Serializable

Serialized Fields

entities

List<Relationship> entities

Class com.mypurecloud.sdk.v2.model.BulkRelationshipsResponse

class BulkRelationshipsResponse extends Object implements Serializable

Serialized Fields

errorCount

Integer errorCount

errorIndexes

List<Integer> errorIndexes

results

List<BulkResponseResultRelationshipRelationship> results

Class com.mypurecloud.sdk.v2.model.BulkResponse

class BulkResponse extends Object implements Serializable

Serialized Fields

errorCount

Integer errorCount

errorIndexes

List<Integer> errorIndexes

results

List<BulkResult> results

Class com.mypurecloud.sdk.v2.model.BulkResponseResultExternalContactEntity

class BulkResponseResultExternalContactEntity extends Object implements Serializable

Serialized Fields

entity

ExternalContact entity

error

BulkErrorEntity error

id

String id

success

Boolean success

Class com.mypurecloud.sdk.v2.model.BulkResponseResultExternalContactExternalContact

class BulkResponseResultExternalContactExternalContact extends Object implements Serializable

Serialized Fields

entity

ExternalContact entity

error

BulkErrorExternalContact error

id

String id

success

Boolean success

Class com.mypurecloud.sdk.v2.model.BulkResponseResultExternalOrganizationEntity

class BulkResponseResultExternalOrganizationEntity extends Object implements Serializable

Serialized Fields

entity

ExternalOrganization entity

error

BulkErrorEntity error

id

String id

success

Boolean success

Class com.mypurecloud.sdk.v2.model.BulkResponseResultExternalOrganizationExternalOrganization

class BulkResponseResultExternalOrganizationExternalOrganization extends Object implements Serializable

Serialized Fields

entity

ExternalOrganization entity

error

BulkErrorExternalOrganization error

id

String id

success

Boolean success

Class com.mypurecloud.sdk.v2.model.BulkResponseResultNoteEntity

class BulkResponseResultNoteEntity extends Object implements Serializable

Serialized Fields

entity

Note entity

error

BulkErrorEntity error

id

String id

success

Boolean success

Class com.mypurecloud.sdk.v2.model.BulkResponseResultNoteNote

class BulkResponseResultNoteNote extends Object implements Serializable

Serialized Fields

entity

Note entity

error

BulkErrorNote error

id

String id

success

Boolean success

Class com.mypurecloud.sdk.v2.model.BulkResponseResultRelationshipEntity

class BulkResponseResultRelationshipEntity extends Object implements Serializable

Serialized Fields

entity

Relationship entity

error

BulkErrorEntity error

id

String id

success

Boolean success

Class com.mypurecloud.sdk.v2.model.BulkResponseResultRelationshipRelationship

class BulkResponseResultRelationshipRelationship extends Object implements Serializable

Serialized Fields

entity

Relationship entity

error

BulkErrorRelationship error

id

String id

success

Boolean success

Class com.mypurecloud.sdk.v2.model.BulkResponseResultVoidEntity

class BulkResponseResultVoidEntity extends Object implements Serializable

Serialized Fields

entity

Object entity

error

BulkErrorEntity error

id

String id

success

Boolean success

Class com.mypurecloud.sdk.v2.model.BulkResult

class BulkResult extends Object implements Serializable

Serialized Fields

entity

Object entity

error

BulkError error

Class com.mypurecloud.sdk.v2.model.BulkShiftTradeStateUpdateRequest

class BulkShiftTradeStateUpdateRequest extends Object implements Serializable

Serialized Fields

entities

List<BulkUpdateShiftTradeStateRequestItem> entities

Class com.mypurecloud.sdk.v2.model.BulkUpdateShiftTradeStateRequestItem

class BulkUpdateShiftTradeStateRequestItem extends Object implements Serializable

Serialized Fields

id

String id

metadata

WfmVersionedEntityMetadata metadata

state

BulkUpdateShiftTradeStateRequestItem.StateEnum state

Class com.mypurecloud.sdk.v2.model.BulkUpdateShiftTradeStateResponse

class BulkUpdateShiftTradeStateResponse extends Object implements Serializable

Serialized Fields

operationId

String operationId

result

BulkUpdateShiftTradeStateResult result

status

BulkUpdateShiftTradeStateResponse.StatusEnum status

Class com.mypurecloud.sdk.v2.model.BulkUpdateShiftTradeStateResult

class BulkUpdateShiftTradeStateResult extends Object implements Serializable

Serialized Fields

entities

List<BulkUpdateShiftTradeStateResultItem> entities

Class com.mypurecloud.sdk.v2.model.BulkUpdateShiftTradeStateResultItem

class BulkUpdateShiftTradeStateResultItem extends Object implements Serializable

Serialized Fields

failureReason

BulkUpdateShiftTradeStateResultItem.FailureReasonEnum failureReason

id

String id

metadata

WfmVersionedEntityMetadata metadata

reviewedBy

UserReference reviewedBy

reviewedDate

Date reviewedDate

state

BulkUpdateShiftTradeStateResultItem.StateEnum state

Class com.mypurecloud.sdk.v2.model.Bullseye

class Bullseye extends Object implements Serializable

Serialized Fields

rings

List<Ring> rings

Class com.mypurecloud.sdk.v2.model.BuManagementUnitScheduleSummary

class BuManagementUnitScheduleSummary extends Object implements Serializable

Serialized Fields

agentCount

Integer agentCount

agents

List<UserReference> agents

endDate

Date endDate

managementUnit

ManagementUnitReference managementUnit

startDate

Date startDate

Class com.mypurecloud.sdk.v2.model.BuPlanningGroupHeadcountForecast

class BuPlanningGroupHeadcountForecast extends Object implements Serializable

Serialized Fields

planningGroup

PlanningGroupReference planningGroup

requiredPerInterval

List<Double> requiredPerInterval

requiredWithoutShrinkagePerInterval

List<Double> requiredWithoutShrinkagePerInterval

Class com.mypurecloud.sdk.v2.model.BuQueryAdherenceExplanationsRequest

class BuQueryAdherenceExplanationsRequest extends Object implements Serializable

Serialized Fields

agentIds

List<String> agentIds

endDate

Date endDate

managementUnitIds

List<String> managementUnitIds

startDate

Date startDate

Class com.mypurecloud.sdk.v2.model.BuQueryAdherenceExplanationsResponse

class BuQueryAdherenceExplanationsResponse extends Object implements Serializable

Serialized Fields

downloadUrl

String downloadUrl

job

AdherenceExplanationJobReference job

result

AdherenceExplanationListingBuQueryResponse result

Class com.mypurecloud.sdk.v2.model.BuQueryAgentSchedulesRequest

class BuQueryAgentSchedulesRequest extends Object implements Serializable

Serialized Fields

managementUnitId

String managementUnitId

teamIds

List<String> teamIds

userIds

List<String> userIds

Class com.mypurecloud.sdk.v2.model.BuRescheduleAgentScheduleResult

class BuRescheduleAgentScheduleResult extends Object implements Serializable

Serialized Fields

downloadResult

MuRescheduleResultWrapper downloadResult

downloadUrl

String downloadUrl

managementUnit

ManagementUnitReference managementUnit

Class com.mypurecloud.sdk.v2.model.BuRescheduleRequest

class BuRescheduleRequest extends Object implements Serializable

Serialized Fields

activityCodeIds

List<String> activityCodeIds

agentIds

List<String> agentIds

doNotChangeDailyPaidTime

Boolean doNotChangeDailyPaidTime

doNotChangeManuallyEditedShifts

Boolean doNotChangeManuallyEditedShifts

doNotChangeShiftStartTimes

Boolean doNotChangeShiftStartTimes

doNotChangeWeeklyPaidTime

Boolean doNotChangeWeeklyPaidTime

endDate

Date endDate

managementUnitIds

List<String> managementUnitIds

startDate

Date startDate

Class com.mypurecloud.sdk.v2.model.BuRescheduleResult

class BuRescheduleResult extends Object implements Serializable

Serialized Fields

agentSchedules

List<BuRescheduleAgentScheduleResult> agentSchedules

generationResults

ScheduleGenerationResult generationResults

generationResultsDownloadUrl

String generationResultsDownloadUrl

headcountForecast

BuHeadcountForecast headcountForecast

headcountForecastDownloadUrl

String headcountForecastDownloadUrl

Class com.mypurecloud.sdk.v2.model.BuScheduleListing

class BuScheduleListing extends Object implements Serializable

Serialized Fields

entities

List<BuScheduleListItem> entities

Class com.mypurecloud.sdk.v2.model.BuScheduleListItem

class BuScheduleListItem extends Object implements Serializable

Serialized Fields

description

String description

generationResults

ScheduleGenerationResultSummary generationResults

id

String id

metadata

WfmVersionedEntityMetadata metadata

published

Boolean published

selfUri

String selfUri

shortTermForecast

BuShortTermForecastReference shortTermForecast

weekCount

Integer weekCount

weekDate

LocalDate weekDate

Class com.mypurecloud.sdk.v2.model.BuScheduleMetadata

class BuScheduleMetadata extends Object implements Serializable

Serialized Fields

description

String description

generationResults

ScheduleGenerationResultSummary generationResults

id

String id

managementUnits

List<BuManagementUnitScheduleSummary> managementUnits

metadata

WfmVersionedEntityMetadata metadata

published

Boolean published

selfUri

String selfUri

shortTermForecast

BuShortTermForecastReference shortTermForecast

weekCount

Integer weekCount

weekDate

LocalDate weekDate

Class com.mypurecloud.sdk.v2.model.BuScheduleReference

class BuScheduleReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

weekDate

LocalDate weekDate

Class com.mypurecloud.sdk.v2.model.BuScheduleReferenceForMuRoute

class BuScheduleReferenceForMuRoute extends Object implements Serializable

Serialized Fields

businessUnit

BusinessUnitReference businessUnit

id

String id

selfUri

String selfUri

weekDate

LocalDate weekDate

Class com.mypurecloud.sdk.v2.model.BuScheduleRun

class BuScheduleRun extends Object implements Serializable

Serialized Fields

id

String id

intradayRescheduling

Boolean intradayRescheduling

messageCount

Integer messageCount

messageSeverityCounts

List<SchedulerMessageSeverityCount> messageSeverityCounts

percentComplete

Double percentComplete

reschedulingOptions

ReschedulingOptionsRunResponse reschedulingOptions

reschedulingResultExpiration

Date reschedulingResultExpiration

schedule

BuScheduleReference schedule

scheduleDescription

String scheduleDescription

schedulerRunId

String schedulerRunId

schedulingCanceledBy

UserReference schedulingCanceledBy

schedulingCompletedTime

Date schedulingCompletedTime

schedulingStartedBy

UserReference schedulingStartedBy

schedulingStartTime

Date schedulingStartTime

selfUri

String selfUri

state

BuScheduleRun.StateEnum state

targetWeek

LocalDate targetWeek

weekCount

Integer weekCount

Class com.mypurecloud.sdk.v2.model.BuScheduleRunListing

class BuScheduleRunListing extends Object implements Serializable

Serialized Fields

entities

List<BuScheduleRun> entities

Class com.mypurecloud.sdk.v2.model.BuSchedulingSettingsRequest

class BuSchedulingSettingsRequest extends Object implements Serializable

Serialized Fields

messageSeverities

List<SchedulerMessageTypeSeverity> messageSeverities

Class com.mypurecloud.sdk.v2.model.BuSchedulingSettingsResponse

class BuSchedulingSettingsResponse extends Object implements Serializable

Serialized Fields

messageSeverities

List<SchedulerMessageTypeSeverity> messageSeverities

Class com.mypurecloud.sdk.v2.model.BuSearchAgentSchedulesRequest

class BuSearchAgentSchedulesRequest extends Object implements Serializable

Serialized Fields

endDate

Date endDate

startDate

Date startDate

userIds

List<String> userIds

Class com.mypurecloud.sdk.v2.model.BuServiceLevel

class BuServiceLevel extends Object implements Serializable

Serialized Fields

include

Boolean include

percent

Integer percent

seconds

Integer seconds

Class com.mypurecloud.sdk.v2.model.BuShortTermForecast

class BuShortTermForecast extends Object implements Serializable

Serialized Fields

canUseForScheduling

Boolean canUseForScheduling

creationMethod

BuShortTermForecast.CreationMethodEnum creationMethod

description

String description

generationResults

BuForecastGenerationResult generationResults

id

String id

legacy

Boolean legacy

metadata

WfmVersionedEntityMetadata metadata

modifications

List<BuForecastModification> modifications

planningGroups

ForecastPlanningGroupsResponse planningGroups

planningGroupsVersion

Integer planningGroupsVersion

referenceStartDate

Date referenceStartDate

selfUri

String selfUri

sourceDays

List<ForecastSourceDayPointer> sourceDays

timeZone

String timeZone

weekCount

Integer weekCount

weekDate

LocalDate weekDate

Class com.mypurecloud.sdk.v2.model.BuShortTermForecastingSettings

class BuShortTermForecastingSettings extends Object implements Serializable

Serialized Fields

defaultHistoryWeeks

Integer defaultHistoryWeeks

Class com.mypurecloud.sdk.v2.model.BuShortTermForecastListing

class BuShortTermForecastListing extends Object implements Serializable

Serialized Fields

entities

List<BuShortTermForecastListItem> entities

Class com.mypurecloud.sdk.v2.model.BuShortTermForecastListItem

class BuShortTermForecastListItem extends Object implements Serializable

Serialized Fields

canUseForScheduling

Boolean canUseForScheduling

creationMethod

BuShortTermForecastListItem.CreationMethodEnum creationMethod

description

String description

id

String id

legacy

Boolean legacy

metadata

WfmVersionedEntityMetadata metadata

selfUri

String selfUri

weekCount

Integer weekCount

weekDate

LocalDate weekDate

Class com.mypurecloud.sdk.v2.model.BuShortTermForecastReference

class BuShortTermForecastReference extends Object implements Serializable

Serialized Fields

description

String description

id

String id

selfUri

String selfUri

weekDate

LocalDate weekDate

Class com.mypurecloud.sdk.v2.model.BusinessUnitActivityCode

class BusinessUnitActivityCode extends Object implements Serializable

Serialized Fields

active

Boolean active

agentTimeOffSelectable

Boolean agentTimeOffSelectable

category

BusinessUnitActivityCode.CategoryEnum category

countsAsPaidTime

Boolean countsAsPaidTime

countsAsWorkTime

Boolean countsAsWorkTime

countsTowardShrinkage

Boolean countsTowardShrinkage

defaultCode

Boolean defaultCode

id

String id

interruptible

Boolean interruptible

lengthInMinutes

Integer lengthInMinutes

metadata

WfmVersionedEntityMetadata metadata

name

String name

plannedShrinkage

Boolean plannedShrinkage

secondaryPresences

List<SecondaryPresence> secondaryPresences

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.BusinessUnitActivityCodeListing

class BusinessUnitActivityCodeListing extends Object implements Serializable

Serialized Fields

entities

List<BusinessUnitActivityCode> entities

Class com.mypurecloud.sdk.v2.model.BusinessUnitListing

class BusinessUnitListing extends Object implements Serializable

Serialized Fields

entities

List<BusinessUnitListItem> entities

Class com.mypurecloud.sdk.v2.model.BusinessUnitListItem

class BusinessUnitListItem extends Object implements Serializable

Serialized Fields

authorized

Boolean authorized

division

DivisionReference division

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.BusinessUnitReference

class BusinessUnitReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.BusinessUnitResponse

class BusinessUnitResponse extends Object implements Serializable

Serialized Fields

division

DivisionReference division

id

String id

name

String name

selfUri

String selfUri

settings

BusinessUnitSettingsResponse settings

Class com.mypurecloud.sdk.v2.model.BusinessUnitSettingsResponse

class BusinessUnitSettingsResponse extends Object implements Serializable

Serialized Fields

metadata

WfmVersionedEntityMetadata metadata

scheduling

BuSchedulingSettingsResponse scheduling

shortTermForecasting

BuShortTermForecastingSettings shortTermForecasting

startDayOfWeek

BusinessUnitSettingsResponse.StartDayOfWeekEnum startDayOfWeek

timeZone

String timeZone

Class com.mypurecloud.sdk.v2.model.ButtonComponent

class ButtonComponent extends Object implements Serializable

Serialized Fields

actions

ContentActions actions

title

String title

Class com.mypurecloud.sdk.v2.model.ButtonResponse

class ButtonResponse extends Object implements Serializable

Serialized Fields

messageType

ButtonResponse.MessageTypeEnum messageType

payload

String payload

text

String text

type

ButtonResponse.TypeEnum type

Class com.mypurecloud.sdk.v2.model.BuUpdateAgentScheduleUploadSchema

class BuUpdateAgentScheduleUploadSchema extends Object implements Serializable

Serialized Fields

delete

Boolean delete

fullDayTimeOffMarkers

List<BuFullDayTimeOffMarker> fullDayTimeOffMarkers

metadata

WfmVersionedEntityMetadata metadata

shifts

List<BuAgentScheduleShift> shifts

userId

String userId

workPlanId

ValueWrapperString workPlanId

workPlanIdsPerWeek

ListWrapperString workPlanIdsPerWeek

Class com.mypurecloud.sdk.v2.model.CalendarUrlResponse

class CalendarUrlResponse extends Object implements Serializable

Serialized Fields

calendarUrl

String calendarUrl

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.Calibration

class Calibration extends Object implements Serializable

Serialized Fields

agent

User agent

averageScore

Integer averageScore

calibrator

User calibrator

contextId

String contextId

conversation

ConversationReference conversation

createdDate

Date createdDate

evaluationForm

EvaluationForm evaluationForm

evaluations

List<Evaluation> evaluations

evaluators

List<User> evaluators

expertEvaluator

User expertEvaluator

highScore

Integer highScore

id

String id

lowScore

Integer lowScore

name

String name

scoringIndex

Evaluation scoringIndex

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CalibrationAssignment

class CalibrationAssignment extends Object implements Serializable

Serialized Fields

calibrator

User calibrator

evaluationForm

EvaluationForm evaluationForm

evaluators

List<User> evaluators

expertEvaluator

User expertEvaluator

Class com.mypurecloud.sdk.v2.model.CalibrationCreate

class CalibrationCreate extends Object implements Serializable

Serialized Fields

agent

User agent

averageScore

Integer averageScore

calibrator

User calibrator

contextId

String contextId

conversation

ConversationReference conversation

createdDate

Date createdDate

evaluationForm

EvaluationForm evaluationForm

evaluations

List<Evaluation> evaluations

evaluators

List<User> evaluators

expertEvaluator

User expertEvaluator

highScore

Integer highScore

id

String id

lowScore

Integer lowScore

name

String name

scoringIndex

Evaluation scoringIndex

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CalibrationEntityListing

class CalibrationEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Calibration> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.Call

class Call extends Object implements Serializable

Serialized Fields

afterCallWork

AfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

agentAssistantId

String agentAssistantId

confined

Boolean confined

connectedTime

Date connectedTime

direction

Call.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectReasons

List<DisconnectReason> disconnectReasons

disconnectType

Call.DisconnectTypeEnum disconnectType

disposition

Disposition disposition

documentId

String documentId

errorInfo

ErrorInfo errorInfo

faxStatus

FaxStatus faxStatus

held

Boolean held

id

String id

initialState

Call.InitialStateEnum initialState

muted

Boolean muted

other

Address other

peerId

String peerId

provider

String provider

recording

Boolean recording

recordingId

String recordingId

recordingState

Call.RecordingStateEnum recordingState

scriptId

String scriptId

securePause

Boolean securePause

segments

List<Segment> segments

self

Address self

startAlertingTime

Date startAlertingTime

startHoldTime

Date startHoldTime

state

Call.StateEnum state

uuiData

String uuiData

wrapup

Wrapup wrapup

Class com.mypurecloud.sdk.v2.model.CallableContactsDiagnostic

class CallableContactsDiagnostic extends Object implements Serializable

Serialized Fields

attemptLimits

DomainEntityRef attemptLimits

callableTimeSet

DomainEntityRef callableTimeSet

dncLists

List<DomainEntityRef> dncLists

ruleSets

List<DomainEntityRef> ruleSets

Class com.mypurecloud.sdk.v2.model.CallableTime

class CallableTime extends Object implements Serializable

Serialized Fields

timeSlots

List<CampaignTimeSlot> timeSlots

timeZoneId

String timeZoneId

Class com.mypurecloud.sdk.v2.model.CallableTimeSet

class CallableTimeSet extends Object implements Serializable

Serialized Fields

callableTimes

List<CallableTime> callableTimes

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

name

String name

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.CallableTimeSetEntityListing

class CallableTimeSetEntityListing extends Object implements Serializable

Serialized Fields

entities

List<CallableTimeSet> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.CallableWindow

class CallableWindow extends Object implements Serializable

Serialized Fields

mapped

AtzmTimeSlot mapped

unmapped

AtzmTimeSlotWithTimeZone unmapped

Class com.mypurecloud.sdk.v2.model.Callback

class Callback extends Object implements Serializable

Serialized Fields

afterCallWork

AfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

automatedCallbackConfigId

String automatedCallbackConfigId

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Date callbackScheduledTime

callbackUserName

String callbackUserName

callerId

String callerId

callerIdName

String callerIdName

connectedTime

Date connectedTime

dialerPreview

DialerPreview dialerPreview

direction

Callback.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectType

Callback.DisconnectTypeEnum disconnectType

externalCampaign

Boolean externalCampaign

held

Boolean held

id

String id

initialState

Callback.InitialStateEnum initialState

peerId

String peerId

provider

String provider

scriptId

String scriptId

segments

List<Segment> segments

skipEnabled

Boolean skipEnabled

startAlertingTime

Date startAlertingTime

startHoldTime

Date startHoldTime

state

Callback.StateEnum state

timeoutSeconds

Integer timeoutSeconds

voicemail

Voicemail voicemail

wrapup

Wrapup wrapup

Class com.mypurecloud.sdk.v2.model.CallbackBasic

class CallbackBasic extends Object implements Serializable

Serialized Fields

afterCallWork

AfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

automatedCallbackConfigId

String automatedCallbackConfigId

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Date callbackScheduledTime

callbackUserName

String callbackUserName

callerId

String callerId

callerIdName

String callerIdName

connectedTime

Date connectedTime

dialerPreview

DialerPreview dialerPreview

direction

CallbackBasic.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectType

CallbackBasic.DisconnectTypeEnum disconnectType

externalCampaign

Boolean externalCampaign

held

Boolean held

id

String id

initialState

CallbackBasic.InitialStateEnum initialState

peerId

String peerId

provider

String provider

scriptId

String scriptId

segments

List<Segment> segments

skipEnabled

Boolean skipEnabled

startAlertingTime

Date startAlertingTime

startHoldTime

Date startHoldTime

state

CallbackBasic.StateEnum state

timeoutSeconds

Integer timeoutSeconds

voicemail

Voicemail voicemail

wrapup

Wrapup wrapup

Class com.mypurecloud.sdk.v2.model.CallbackConversation

class CallbackConversation extends Object implements Serializable

Serialized Fields

id

String id

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<CallbackMediaParticipant> participants

recentTransfers

List<TransferResponse> recentTransfers

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CallbackConversationEntityListing

class CallbackConversationEntityListing extends Object implements Serializable

Serialized Fields

entities

List<CallbackConversation> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.CallbackDisconnectIdentifier

class CallbackDisconnectIdentifier extends Object implements Serializable

Serialized Fields

callbackId

String callbackId

conversationId

String conversationId

Class com.mypurecloud.sdk.v2.model.CallbackIdentifier

class CallbackIdentifier extends Object implements Serializable

Serialized Fields

id

String id

type

CallbackIdentifier.TypeEnum type

Class com.mypurecloud.sdk.v2.model.CallbackMediaParticipant

class CallbackMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

automatedCallbackConfigId

String automatedCallbackConfigId

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Date callbackScheduledTime

callbackUserName

String callbackUserName

connectedTime

Date connectedTime

conversationRoutingData

ConversationRoutingData conversationRoutingData

direction

CallbackMediaParticipant.DirectionEnum direction

disconnectType

CallbackMediaParticipant.DisconnectTypeEnum disconnectType

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

ErrorInfo errorInfo

externalCampaign

Boolean externalCampaign

externalContact

DomainEntityRef externalContact

externalOrganization

DomainEntityRef externalOrganization

flaggedReason

CallbackMediaParticipant.FlaggedReasonEnum flaggedReason

held

Boolean held

id

String id

journeyContext

JourneyContext journeyContext

mediaRoles

List<String> mediaRoles

name

String name

outboundPreview

DialerPreview outboundPreview

peer

String peer

provider

String provider

purpose

String purpose

queue

DomainEntityRef queue

script

DomainEntityRef script

skipEnabled

Boolean skipEnabled

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

CallbackMediaParticipant.StateEnum state

team

DomainEntityRef team

timeoutSeconds

Integer timeoutSeconds

user

DomainEntityRef user

voicemail

Voicemail voicemail

wrapup

Wrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.CallbackMediaSettings

class CallbackMediaSettings extends Object implements Serializable

Serialized Fields

alertingTimeoutSeconds

Integer alertingTimeoutSeconds

enableAutoAnswer

Boolean enableAutoAnswer

serviceLevel

ServiceLevel serviceLevel

subTypeSettings

Map<String,BaseMediaSettings> subTypeSettings

Class com.mypurecloud.sdk.v2.model.CallBasic

class CallBasic extends Object implements Serializable

Serialized Fields

afterCallWork

AfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

agentAssistantId

String agentAssistantId

confined

Boolean confined

connectedTime

Date connectedTime

direction

CallBasic.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectReasons

List<DisconnectReason> disconnectReasons

disconnectType

CallBasic.DisconnectTypeEnum disconnectType

disposition

Disposition disposition

documentId

String documentId

errorInfo

ErrorInfo errorInfo

faxStatus

FaxStatus faxStatus

held

Boolean held

id

String id

initialState

CallBasic.InitialStateEnum initialState

muted

Boolean muted

other

Address other

peerId

String peerId

provider

String provider

recording

Boolean recording

recordingId

String recordingId

recordingState

CallBasic.RecordingStateEnum recordingState

scriptId

String scriptId

securePause

Boolean securePause

segments

List<Segment> segments

self

Address self

startAlertingTime

Date startAlertingTime

startHoldTime

Date startHoldTime

state

CallBasic.StateEnum state

uuiData

String uuiData

wrapup

Wrapup wrapup

Class com.mypurecloud.sdk.v2.model.CallCommand

class CallCommand extends Object implements Serializable

Serialized Fields

callNumber

String callNumber

phoneColumn

String phoneColumn

Class com.mypurecloud.sdk.v2.model.CallConversation

class CallConversation extends Object implements Serializable

Serialized Fields

id

String id

maxParticipants

Integer maxParticipants

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<CallMediaParticipant> participants

recentTransfers

List<TransferResponse> recentTransfers

recordingState

CallConversation.RecordingStateEnum recordingState

securePause

Boolean securePause

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CallConversationEntityListing

class CallConversationEntityListing extends Object implements Serializable

Serialized Fields

entities

List<CallConversation> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.CallForwarding

class CallForwarding extends Object implements Serializable

Serialized Fields

calls

List<CallRoute> calls

enabled

Boolean enabled

id

String id

modifiedDate

Date modifiedDate

name

String name

phoneNumber

String phoneNumber

selfUri

String selfUri

user

User user

voicemail

CallForwarding.VoicemailEnum voicemail

Class com.mypurecloud.sdk.v2.model.CallForwardingEventCall

class CallForwardingEventCall extends Object implements Serializable

Serialized Fields

targets

List<CallForwardingEventTarget> targets

Class com.mypurecloud.sdk.v2.model.CallForwardingEventCallForwarding

class CallForwardingEventCallForwarding extends Object implements Serializable

Serialized Fields

calls

List<CallForwardingEventCall> calls

enabled

Boolean enabled

modifiedDate

Date modifiedDate

user

CallForwardingEventUser user

voicemail

String voicemail

Class com.mypurecloud.sdk.v2.model.CallForwardingEventTarget

class CallForwardingEventTarget extends Object implements Serializable

Serialized Fields

type

String type

value

String value

Class com.mypurecloud.sdk.v2.model.CallForwardingEventUser

class CallForwardingEventUser extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.CallHistoryConversation

class CallHistoryConversation extends Object implements Serializable

Serialized Fields

direction

CallHistoryConversation.DirectionEnum direction

hadCobrowse

Boolean hadCobrowse

hadScreenShare

Boolean hadScreenShare

id

String id

missedCall

Boolean missedCall

name

String name

participants

List<CallHistoryParticipant> participants

selfUri

String selfUri

startTime

Date startTime

wasCallback

Boolean wasCallback

wasConference

Boolean wasConference

wasOutboundCampaign

Boolean wasOutboundCampaign

wentToVoicemail

Boolean wentToVoicemail

Class com.mypurecloud.sdk.v2.model.CallHistoryConversationEntityListing

class CallHistoryConversationEntityListing extends Object implements Serializable

Serialized Fields

entities

List<CallHistoryConversation> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.CallHistoryParticipant

class CallHistoryParticipant extends Object implements Serializable

Serialized Fields

address

String address

ani

String ani

didInteract

Boolean didInteract

direction

CallHistoryParticipant.DirectionEnum direction

disconnectType

CallHistoryParticipant.DisconnectTypeEnum disconnectType

dnis

String dnis

endTime

Date endTime

externalContact

ExternalContact externalContact

externalOrganization

ExternalOrganization externalOrganization

flaggedReason

CallHistoryParticipant.FlaggedReasonEnum flaggedReason

group

Group group

id

String id

name

String name

outboundCampaign

Campaign outboundCampaign

purpose

String purpose

queue

Queue queue

sipResponseCodes

List<Long> sipResponseCodes

startTime

Date startTime

user

User user

Class com.mypurecloud.sdk.v2.model.CallMediaParticipant

class CallMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

ani

String ani

attributes

Map<String,String> attributes

bargedParticipantId

String bargedParticipantId

bargedTime

Date bargedTime

coachedParticipantId

String coachedParticipantId

confined

Boolean confined

connectedTime

Date connectedTime

consultParticipantId

String consultParticipantId

conversationRoutingData

ConversationRoutingData conversationRoutingData

direction

CallMediaParticipant.DirectionEnum direction

disconnectType

CallMediaParticipant.DisconnectTypeEnum disconnectType

dnis

String dnis

documentId

String documentId

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

ErrorInfo errorInfo

externalContact

DomainEntityRef externalContact

externalOrganization

DomainEntityRef externalOrganization

faxStatus

FaxStatus faxStatus

flaggedReason

CallMediaParticipant.FlaggedReasonEnum flaggedReason

group

DomainEntityRef group

held

Boolean held

id

String id

journeyContext

JourneyContext journeyContext

mediaRoles

List<String> mediaRoles

monitoredParticipantId

String monitoredParticipantId

muted

Boolean muted

name

String name

peer

String peer

provider

String provider

purpose

String purpose

queue

DomainEntityRef queue

recording

Boolean recording

recordingState

CallMediaParticipant.RecordingStateEnum recordingState

script

DomainEntityRef script

securePause

Boolean securePause

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

CallMediaParticipant.StateEnum state

team

DomainEntityRef team

user

DomainEntityRef user

uuiData

String uuiData

wrapup

Wrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.CallMediaPolicy

class CallMediaPolicy extends Object implements Serializable

Serialized Fields

actions

PolicyActions actions

conditions

CallMediaPolicyConditions conditions

Class com.mypurecloud.sdk.v2.model.CallMediaPolicyConditions

class CallMediaPolicyConditions extends Object implements Serializable

Serialized Fields

dateRanges

List<String> dateRanges

directions

List<CallMediaPolicyConditions.DirectionsEnum> directions

duration

DurationCondition duration

forQueues

List<Queue> forQueues

forUsers

List<User> forUsers

languages

List<Language> languages

timeAllowed

TimeAllowed timeAllowed

wrapupCodes

List<WrapupCode> wrapupCodes

Class com.mypurecloud.sdk.v2.model.CallRecord

class CallRecord extends Object implements Serializable

Serialized Fields

lastAttempt

Date lastAttempt

lastResult

String lastResult

Class com.mypurecloud.sdk.v2.model.CallRoute

class CallRoute extends Object implements Serializable

Serialized Fields

targets

List<CallTarget> targets

Class com.mypurecloud.sdk.v2.model.CallTarget

class CallTarget extends Object implements Serializable

Serialized Fields

type

CallTarget.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.CallToAction

class CallToAction extends Object implements Serializable

Serialized Fields

target

CallToAction.TargetEnum target

text

String text

url

String url

Class com.mypurecloud.sdk.v2.model.Campaign

class Campaign extends Object implements Serializable

Serialized Fields

abandonRate

Double abandonRate

alwaysRunning

Boolean alwaysRunning

callableTimeSet

DomainEntityRef callableTimeSet

callAnalysisLanguage

String callAnalysisLanguage

callAnalysisResponseSet

DomainEntityRef callAnalysisResponseSet

callerAddress

String callerAddress

callerName

String callerName

campaignStatus

Campaign.CampaignStatusEnum campaignStatus

contactList

DomainEntityRef contactList

contactListFilters

List<DomainEntityRef> contactListFilters

contactSort

ContactSort contactSort

contactSorts

List<ContactSort> contactSorts

dateCreated

Date dateCreated

dateModified

Date dateModified

dialingMode

Campaign.DialingModeEnum dialingMode

division

DomainEntityRef division

dncLists

List<DomainEntityRef> dncLists

dynamicContactQueueingSettings

DynamicContactQueueingSettings dynamicContactQueueingSettings

edgeGroup

DomainEntityRef edgeGroup

errors

List<RestErrorDetail> errors

id

String id

name

String name

noAnswerTimeout

Integer noAnswerTimeout

outboundLineCount

Integer outboundLineCount

phoneColumns

List<PhoneColumn> phoneColumns

previewTimeOutSeconds

Long previewTimeOutSeconds

priority

Integer priority

queue

DomainEntityRef queue

ruleSets

List<DomainEntityRef> ruleSets

script

DomainEntityRef script

selfUri

String selfUri

site

DomainEntityRef site

skipPreviewDisabled

Boolean skipPreviewDisabled

version

Integer version

Class com.mypurecloud.sdk.v2.model.CampaignDiagnostics

class CampaignDiagnostics extends Object implements Serializable

Serialized Fields

callableContacts

CallableContactsDiagnostic callableContacts

outstandingInteractionsCount

Integer outstandingInteractionsCount

queueUtilizationDiagnostic

QueueUtilizationDiagnostic queueUtilizationDiagnostic

ruleSetDiagnostics

List<RuleSetDiagnostic> ruleSetDiagnostics

scheduledInteractionsCount

Integer scheduledInteractionsCount

timeZoneRescheduledCallsCount

Integer timeZoneRescheduledCallsCount

Class com.mypurecloud.sdk.v2.model.CampaignDivisionView

class CampaignDivisionView extends Object implements Serializable

Serialized Fields

division

Division division

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CampaignDivisionViewListing

class CampaignDivisionViewListing extends Object implements Serializable

Serialized Fields

entities

List<CampaignDivisionView> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.CampaignEntityListing

class CampaignEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Campaign> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.CampaignInteraction

class CampaignInteraction extends Object implements Serializable

Serialized Fields

activePreviewCall

Boolean activePreviewCall

agent

DomainEntityRef agent

callerAddress

String callerAddress

callerName

String callerName

callPlacedTime

Date callPlacedTime

callRoutedTime

Date callRoutedTime

campaign

DomainEntityRef campaign

contact

DomainEntityRef contact

conversation

ConversationBasic conversation

creationTime

Date creationTime

destinationAddress

String destinationAddress

dialerSystemParticipantId

String dialerSystemParticipantId

dialingMode

String dialingMode

disposition

CampaignInteraction.DispositionEnum disposition

id

String id

lastActivePreviewWrapupTime

Date lastActivePreviewWrapupTime

previewConnectedTime

Date previewConnectedTime

previewPopDeliveredTime

Date previewPopDeliveredTime

queue

DomainEntityRef queue

script

DomainEntityRef script

skills

List<DomainEntityRef> skills

Class com.mypurecloud.sdk.v2.model.CampaignInteractions

class CampaignInteractions extends Object implements Serializable

Serialized Fields

campaign

DomainEntityRef campaign

interactingInteractions

List<CampaignInteraction> interactingInteractions

pendingInteractions

List<CampaignInteraction> pendingInteractions

previewingInteractions

List<CampaignInteraction> previewingInteractions

proceedingInteractions

List<CampaignInteraction> proceedingInteractions

scheduledInteractions

List<CampaignInteraction> scheduledInteractions

Class com.mypurecloud.sdk.v2.model.CampaignProgress

class CampaignProgress extends Object implements Serializable

Serialized Fields

campaign

DomainEntityRef campaign

contactList

DomainEntityRef contactList

numberOfContactsCalled

Long numberOfContactsCalled

numberOfContactsMessaged

Long numberOfContactsMessaged

percentage

Long percentage

totalNumberOfContacts

Long totalNumberOfContacts

Class com.mypurecloud.sdk.v2.model.CampaignRule

class CampaignRule extends Object implements Serializable

Serialized Fields

campaignRuleActions

List<CampaignRuleAction> campaignRuleActions

campaignRuleConditions

List<CampaignRuleCondition> campaignRuleConditions

campaignRuleEntities

CampaignRuleEntities campaignRuleEntities

dateCreated

Date dateCreated

dateModified

Date dateModified

enabled

Boolean enabled

id

String id

matchAnyConditions

Boolean matchAnyConditions

name

String name

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.CampaignRuleAction

class CampaignRuleAction extends Object implements Serializable

Serialized Fields

actionType

CampaignRuleAction.ActionTypeEnum actionType

campaignRuleActionEntities

CampaignRuleActionEntities campaignRuleActionEntities

id

String id

parameters

CampaignRuleParameters parameters

Class com.mypurecloud.sdk.v2.model.CampaignRuleActionEntities

class CampaignRuleActionEntities extends Object implements Serializable

Serialized Fields

campaigns

List<DomainEntityRef> campaigns

sequences

List<DomainEntityRef> sequences

useTriggeringEntity

Boolean useTriggeringEntity

Class com.mypurecloud.sdk.v2.model.CampaignRuleCondition

class CampaignRuleCondition extends Object implements Serializable

Serialized Fields

conditionType

CampaignRuleCondition.ConditionTypeEnum conditionType

id

String id

parameters

CampaignRuleParameters parameters

Class com.mypurecloud.sdk.v2.model.CampaignRuleEntities

class CampaignRuleEntities extends Object implements Serializable

Serialized Fields

campaigns

List<DomainEntityRef> campaigns

sequences

List<DomainEntityRef> sequences

Class com.mypurecloud.sdk.v2.model.CampaignRuleEntityListing

class CampaignRuleEntityListing extends Object implements Serializable

Serialized Fields

entities

List<CampaignRule> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.CampaignRuleParameters

class CampaignRuleParameters extends Object implements Serializable

Serialized Fields

dialingMode

CampaignRuleParameters.DialingModeEnum dialingMode

operator

CampaignRuleParameters.OperatorEnum operator

priority

CampaignRuleParameters.PriorityEnum priority

value

String value

Class com.mypurecloud.sdk.v2.model.CampaignSchedule

class CampaignSchedule extends Object implements Serializable

Serialized Fields

campaign

DomainEntityRef campaign

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

intervals

List<ScheduleInterval> intervals

name

String name

selfUri

String selfUri

timeZone

String timeZone

version

Integer version

Class com.mypurecloud.sdk.v2.model.CampaignSequence

class CampaignSequence extends Object implements Serializable

Serialized Fields

campaigns

List<DomainEntityRef> campaigns

currentCampaign

Integer currentCampaign

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

name

String name

repeat

Boolean repeat

selfUri

String selfUri

status

CampaignSequence.StatusEnum status

stopMessage

String stopMessage

version

Integer version

Class com.mypurecloud.sdk.v2.model.CampaignSequenceEntityListing

class CampaignSequenceEntityListing extends Object implements Serializable

Serialized Fields

entities

List<CampaignSequence> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.CampaignStats

class CampaignStats extends Object implements Serializable

Serialized Fields

adjustedCallsPerAgent

Double adjustedCallsPerAgent

contactRate

ConnectRate contactRate

effectiveIdleAgents

Double effectiveIdleAgents

idleAgents

Integer idleAgents

outstandingCalls

Integer outstandingCalls

scheduledCalls

Integer scheduledCalls

timeZoneRescheduledCalls

Integer timeZoneRescheduledCalls

Class com.mypurecloud.sdk.v2.model.CampaignTimeSlot

class CampaignTimeSlot extends Object implements Serializable

Serialized Fields

day

Integer day

startTime

String startTime

stopTime

String stopTime

Class com.mypurecloud.sdk.v2.model.Card

class Card extends Object implements Serializable

Serialized Fields

actions

List<CardAction> actions

defaultAction

CardAction defaultAction

description

String description

title

String title

url

String url

Class com.mypurecloud.sdk.v2.model.CardAction

class CardAction extends Object implements Serializable

Serialized Fields

isSelected

Boolean isSelected

payload

String payload

text

String text

type

CardAction.TypeEnum type

url

String url

Class com.mypurecloud.sdk.v2.model.Category

class Category extends Object implements Serializable

Serialized Fields

name

String name

Class com.mypurecloud.sdk.v2.model.CategoryEntityListing

class CategoryEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Category> entities

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

total

Long total

Class com.mypurecloud.sdk.v2.model.CategoryListing

class CategoryListing extends Object implements Serializable

Serialized Fields

entities

List<KnowledgeCategory> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CategoryReference

class CategoryReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

parentCategory

CategoryReference parentCategory

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CategoryRequest

class CategoryRequest extends Object implements Serializable

Serialized Fields

description

String description

id

String id

name

String name

parentCategoryId

String parentCategoryId

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CategoryResponse

class CategoryResponse extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

documentCount

Integer documentCount

id

String id

knowledgeBase

KnowledgeBaseReference knowledgeBase

name

String name

parentCategory

CategoryReference parentCategory

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CategoryResponseListing

class CategoryResponseListing extends Object implements Serializable

Serialized Fields

entities

List<CategoryResponse> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.Certificate

class Certificate extends Object implements Serializable

Serialized Fields

certificate

String certificate

Class com.mypurecloud.sdk.v2.model.CertificateAuthorityEntityListing

class CertificateAuthorityEntityListing extends Object implements Serializable

Serialized Fields

entities

List<DomainCertificateAuthority> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.CertificateDetails

class CertificateDetails extends Object implements Serializable

Serialized Fields

expirationDate

Date expirationDate

expired

Boolean expired

issueDate

Date issueDate

issuer

String issuer

signatureValid

Boolean signatureValid

subject

String subject

valid

Boolean valid

Class com.mypurecloud.sdk.v2.model.Change

class Change extends Object implements Serializable

Serialized Fields

entity

AuditEntity entity

newValues

List<String> newValues

oldValues

List<String> oldValues

property

String property

Class com.mypurecloud.sdk.v2.model.ChangeMyPasswordRequest

class ChangeMyPasswordRequest extends Object implements Serializable

Serialized Fields

newPassword

String newPassword

oldPassword

String oldPassword

Class com.mypurecloud.sdk.v2.model.ChangePasswordRequest

class ChangePasswordRequest extends Object implements Serializable

Serialized Fields

newPassword

String newPassword

Class com.mypurecloud.sdk.v2.model.Channel

class Channel extends Object implements Serializable

Serialized Fields

connectUri

String connectUri

expires

Date expires

id

String id

Class com.mypurecloud.sdk.v2.model.ChannelEntityListing

class ChannelEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Channel> entities

Class com.mypurecloud.sdk.v2.model.ChannelTopic

class ChannelTopic extends Object implements Serializable

Serialized Fields

id

String id

rejectionReason

String rejectionReason

selfUri

String selfUri

state

ChannelTopic.StateEnum state

Class com.mypurecloud.sdk.v2.model.ChannelTopicEntityListing

class ChannelTopicEntityListing extends Object implements Serializable

Serialized Fields

entities

List<ChannelTopic> entities

Class com.mypurecloud.sdk.v2.model.Chat

class Chat extends Object implements Serializable

Serialized Fields

jabberId

String jabberId

Class com.mypurecloud.sdk.v2.model.ChatBadgeTopicBadgeEntity

class ChatBadgeTopicBadgeEntity extends Object implements Serializable

Serialized Fields

jabberId

String jabberId

Class com.mypurecloud.sdk.v2.model.ChatBadgeTopicChatBadge

class ChatBadgeTopicChatBadge extends Object implements Serializable

Serialized Fields

entity

ChatBadgeTopicBadgeEntity entity

lastUnreadNotificationDate

Date lastUnreadNotificationDate

unreadCount

Integer unreadCount

Class com.mypurecloud.sdk.v2.model.ChatConversation

class ChatConversation extends Object implements Serializable

Serialized Fields

id

String id

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<ChatMediaParticipant> participants

recentTransfers

List<TransferResponse> recentTransfers

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ChatConversationEntityListing

class ChatConversationEntityListing extends Object implements Serializable

Serialized Fields

entities

List<ChatConversation> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ChatMediaParticipant

class ChatMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

avatarImageUrl

String avatarImageUrl

connectedTime

Date connectedTime

conversationRoutingData

ConversationRoutingData conversationRoutingData

direction

ChatMediaParticipant.DirectionEnum direction

disconnectType

ChatMediaParticipant.DisconnectTypeEnum disconnectType

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

ErrorInfo errorInfo

externalContact

DomainEntityRef externalContact

externalOrganization

DomainEntityRef externalOrganization

flaggedReason

ChatMediaParticipant.FlaggedReasonEnum flaggedReason

held

Boolean held

id

String id

journeyContext

JourneyContext journeyContext

mediaRoles

List<String> mediaRoles

name

String name

peer

String peer

provider

String provider

purpose

String purpose

queue

DomainEntityRef queue

roomId

String roomId

script

DomainEntityRef script

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

ChatMediaParticipant.StateEnum state

team

DomainEntityRef team

user

DomainEntityRef user

wrapup

Wrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.ChatMediaPolicy

class ChatMediaPolicy extends Object implements Serializable

Serialized Fields

actions

PolicyActions actions

conditions

ChatMediaPolicyConditions conditions

Class com.mypurecloud.sdk.v2.model.ChatMediaPolicyConditions

class ChatMediaPolicyConditions extends Object implements Serializable

Serialized Fields

dateRanges

List<String> dateRanges

duration

DurationCondition duration

forQueues

List<Queue> forQueues

forUsers

List<User> forUsers

languages

List<Language> languages

timeAllowed

TimeAllowed timeAllowed

wrapupCodes

List<WrapupCode> wrapupCodes

Class com.mypurecloud.sdk.v2.model.ChatMessage

class ChatMessage extends Object implements Serializable

Serialized Fields

body

String body

bodyType

ChatMessage.BodyTypeEnum bodyType

chat

String chat

from

String from

id

String id

message

String message

participantPurpose

String participantPurpose

senderCommunicationId

String senderCommunicationId

to

String to

type

String type

user

ChatMessageUser user

utc

String utc

Class com.mypurecloud.sdk.v2.model.ChatMessageUser

class ChatMessageUser extends Object implements Serializable

Serialized Fields

displayName

String displayName

id

String id

images

List<UserImage> images

name

String name

username

String username

Class com.mypurecloud.sdk.v2.model.ChatSettings

class ChatSettings extends Object implements Serializable

Serialized Fields

messageRetentionPeriodDays

Integer messageRetentionPeriodDays

Class com.mypurecloud.sdk.v2.model.Check

class Check extends Object implements Serializable

Serialized Fields

result

Check.ResultEnum result

type

Check.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ClientApp

class ClientApp extends Object implements Serializable

Serialized Fields

attributes

Map<String,String> attributes

config

ClientAppConfigurationInfo config

id

String id

integrationType

IntegrationType integrationType

intendedState

ClientApp.IntendedStateEnum intendedState

name

String name

notes

String notes

reportedState

IntegrationStatusInfo reportedState

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ClientAppConfigurationInfo

class ClientAppConfigurationInfo extends Object implements Serializable

Serialized Fields

current

IntegrationConfiguration current

effective

EffectiveConfiguration effective

Class com.mypurecloud.sdk.v2.model.ClientAppEntityListing

class ClientAppEntityListing extends Object implements Serializable

Serialized Fields

entities

List<ClientApp> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ClonedUser

class ClonedUser extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

trustor

DomainEntityRef trustor

Class com.mypurecloud.sdk.v2.model.ClonedUserEntityListing

class ClonedUserEntityListing extends Object implements Serializable

Serialized Fields

entities

List<ClonedUser> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.CloseButtonStyleProperties

class CloseButtonStyleProperties extends Object implements Serializable

Serialized Fields

color

String color

opacity

Float opacity

Class com.mypurecloud.sdk.v2.model.CoachingAnnotation

class CoachingAnnotation extends Object implements Serializable

Serialized Fields

accessType

CoachingAnnotation.AccessTypeEnum accessType

createdBy

UserReference createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

isDeleted

Boolean isDeleted

modifiedBy

UserReference modifiedBy

selfUri

String selfUri

text

String text

Class com.mypurecloud.sdk.v2.model.CoachingAnnotationCreateRequest

class CoachingAnnotationCreateRequest extends Object implements Serializable

Serialized Fields

accessType

CoachingAnnotationCreateRequest.AccessTypeEnum accessType

text

String text

Class com.mypurecloud.sdk.v2.model.CoachingAnnotationList

class CoachingAnnotationList extends Object implements Serializable

Serialized Fields

entities

List<CoachingAnnotation> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.CoachingAppointmentAggregateRequest

class CoachingAppointmentAggregateRequest extends Object implements Serializable

Serialized Fields

filter

QueryRequestFilter filter

groupBy

List<CoachingAppointmentAggregateRequest.GroupByEnum> groupBy

interval

String interval

metrics

List<CoachingAppointmentAggregateRequest.MetricsEnum> metrics

Class com.mypurecloud.sdk.v2.model.CoachingAppointmentAggregateResponse

class CoachingAppointmentAggregateResponse extends Object implements Serializable

Serialized Fields

results

List<QueryResponseGroupedData> results

Class com.mypurecloud.sdk.v2.model.CoachingAppointmentReference

class CoachingAppointmentReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CoachingAppointmentResponse

class CoachingAppointmentResponse extends Object implements Serializable

Serialized Fields

attendees

List<UserReference> attendees

conversations

List<ConversationReference> conversations

createdBy

UserReference createdBy

dateCompleted

Date dateCompleted

dateCreated

Date dateCreated

dateModified

Date dateModified

dateStart

Date dateStart

description

String description

documents

List<DocumentReference> documents

externalLinks

List<String> externalLinks

facilitator

UserReference facilitator

id

String id

isOverdue

Boolean isOverdue

lengthInMinutes

Integer lengthInMinutes

modifiedBy

UserReference modifiedBy

name

String name

selfUri

String selfUri

status

CoachingAppointmentResponse.StatusEnum status

wfmSchedule

WfmScheduleReference wfmSchedule

Class com.mypurecloud.sdk.v2.model.CoachingAppointmentResponseList

class CoachingAppointmentResponseList extends Object implements Serializable

Serialized Fields

entities

List<CoachingAppointmentResponse> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.CoachingAppointmentStatusRequest

class CoachingAppointmentStatusRequest extends Object implements Serializable

Serialized Fields

status

CoachingAppointmentStatusRequest.StatusEnum status

Class com.mypurecloud.sdk.v2.model.CoachingAppointmentStatusResponse

class CoachingAppointmentStatusResponse extends Object implements Serializable

Serialized Fields

appointment

CoachingAppointmentReference appointment

createdBy

UserReference createdBy

dateCreated

Date dateCreated

status

CoachingAppointmentStatusResponse.StatusEnum status

Class com.mypurecloud.sdk.v2.model.CoachingAppointmentStatusResponseList

class CoachingAppointmentStatusResponseList extends Object implements Serializable

Serialized Fields

entities

List<CoachingAppointmentStatusResponse> entities

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

total

Long total

Class com.mypurecloud.sdk.v2.model.CoachingNotification

class CoachingNotification extends Object implements Serializable

Serialized Fields

actionType

CoachingNotification.ActionTypeEnum actionType

appointment

CoachingAppointmentResponse appointment

dateStart

Date dateStart

id

String id

lengthInMinutes

Integer lengthInMinutes

markedAsRead

Boolean markedAsRead

name

String name

relationship

CoachingNotification.RelationshipEnum relationship

selfUri

String selfUri

status

CoachingNotification.StatusEnum status

user

UserReference user

Class com.mypurecloud.sdk.v2.model.CoachingNotificationList

class CoachingNotificationList extends Object implements Serializable

Serialized Fields

entities

List<CoachingNotification> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.CoachingSlot

class CoachingSlot extends Object implements Serializable

Serialized Fields

dateStart

Date dateStart

differenceRating

CoachingSlot.DifferenceRatingEnum differenceRating

lengthInMinutes

Integer lengthInMinutes

staffingDifference

Double staffingDifference

wfmSchedule

WfmScheduleReference wfmSchedule

Class com.mypurecloud.sdk.v2.model.CoachingSlotsRequest

class CoachingSlotsRequest extends Object implements Serializable

Serialized Fields

attendeeIds

List<String> attendeeIds

facilitatorIds

List<String> facilitatorIds

interruptibleAppointmentIds

List<String> interruptibleAppointmentIds

interval

String interval

lengthInMinutes

Integer lengthInMinutes

Class com.mypurecloud.sdk.v2.model.CoachingSlotsResponse

class CoachingSlotsResponse extends Object implements Serializable

Serialized Fields

attendeeSchedules

List<UserAvailableTimes> attendeeSchedules

facilitatorSchedules

List<UserAvailableTimes> facilitatorSchedules

suggestedSlots

List<CoachingSlot> suggestedSlots

wfmScheduleActivities

List<WfmScheduleActivity> wfmScheduleActivities

Class com.mypurecloud.sdk.v2.model.CobrowseConversation

class CobrowseConversation extends Object implements Serializable

Serialized Fields

id

String id

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<CobrowseMediaParticipant> participants

recentTransfers

List<TransferResponse> recentTransfers

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CobrowseConversationEntityListing

class CobrowseConversationEntityListing extends Object implements Serializable

Serialized Fields

entities

List<CobrowseConversation> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.CobrowseMediaParticipant

class CobrowseMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

cobrowseRole

String cobrowseRole

cobrowseSessionId

String cobrowseSessionId

connectedTime

Date connectedTime

controlling

List<String> controlling

conversationRoutingData

ConversationRoutingData conversationRoutingData

direction

CobrowseMediaParticipant.DirectionEnum direction

disconnectType

CobrowseMediaParticipant.DisconnectTypeEnum disconnectType

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

ErrorInfo errorInfo

externalContact

DomainEntityRef externalContact

externalOrganization

DomainEntityRef externalOrganization

flaggedReason

CobrowseMediaParticipant.FlaggedReasonEnum flaggedReason

held

Boolean held

id

String id

journeyContext

JourneyContext journeyContext

mediaRoles

List<String> mediaRoles

name

String name

peer

String peer

provider

String provider

providerEventTime

Date providerEventTime

purpose

String purpose

queue

DomainEntityRef queue

script

DomainEntityRef script

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

CobrowseMediaParticipant.StateEnum state

team

DomainEntityRef team

user

DomainEntityRef user

viewerUrl

String viewerUrl

wrapup

Wrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.Cobrowsesession

class Cobrowsesession extends Object implements Serializable

Serialized Fields

afterCallWork

AfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

cobrowseRole

String cobrowseRole

cobrowseSessionId

String cobrowseSessionId

connectedTime

Date connectedTime

controlling

List<String> controlling

disconnectedTime

Date disconnectedTime

disconnectType

Cobrowsesession.DisconnectTypeEnum disconnectType

id

String id

initialState

Cobrowsesession.InitialStateEnum initialState

peerId

String peerId

provider

String provider

providerEventTime

Date providerEventTime

segments

List<Segment> segments

self

Address self

startAlertingTime

Date startAlertingTime

state

Cobrowsesession.StateEnum state

viewerUrl

String viewerUrl

wrapup

Wrapup wrapup

Class com.mypurecloud.sdk.v2.model.CobrowseSettings

class CobrowseSettings extends Object implements Serializable

Serialized Fields

allowAgentControl

Boolean allowAgentControl

channels

List<CobrowseSettings.ChannelsEnum> channels

enabled

Boolean enabled

maskSelectors

List<String> maskSelectors

readonlySelectors

List<String> readonlySelectors

Class com.mypurecloud.sdk.v2.model.CobrowseWebMessagingSession

class CobrowseWebMessagingSession extends Object implements Serializable

Serialized Fields

communicationType

CobrowseWebMessagingSession.CommunicationTypeEnum communicationType

dateOfferEnds

Date dateOfferEnds

id

String id

joinCode

String joinCode

name

String name

selfUri

String selfUri

websocketUrl

String websocketUrl

Class com.mypurecloud.sdk.v2.model.ColumnDataTypeSpecification

class ColumnDataTypeSpecification extends Object implements Serializable

Serialized Fields

columnDataType

ColumnDataTypeSpecification.ColumnDataTypeEnum columnDataType

columnName

String columnName

max

Integer max

maxLength

Integer maxLength

min

Integer min

Class com.mypurecloud.sdk.v2.model.ColumnStatus

class ColumnStatus extends Object implements Serializable

Serialized Fields

contactable

Boolean contactable

Class com.mypurecloud.sdk.v2.model.CommandStatus

class CommandStatus extends Object implements Serializable

Serialized Fields

commandType

CommandStatus.CommandTypeEnum commandType

document

Document document

expiration

Date expiration

id

String id

name

String name

selfUri

String selfUri

statusCode

CommandStatus.StatusCodeEnum statusCode

userId

String userId

Class com.mypurecloud.sdk.v2.model.CommandStatusEntityListing

class CommandStatusEntityListing extends Object implements Serializable

Serialized Fields

entities

List<CommandStatus> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.CommonCampaign

class CommonCampaign extends Object implements Serializable

Serialized Fields

division

Division division

id

String id

mediaType

CommonCampaign.MediaTypeEnum mediaType

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CommonCampaignDivisionView

class CommonCampaignDivisionView extends Object implements Serializable

Serialized Fields

division

Division division

id

String id

mediaType

CommonCampaignDivisionView.MediaTypeEnum mediaType

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CommonCampaignDivisionViewEntityListing

class CommonCampaignDivisionViewEntityListing extends Object implements Serializable

Serialized Fields

entities

List<CommonCampaignDivisionView> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.CommonCampaignEntityListing

class CommonCampaignEntityListing extends Object implements Serializable

Serialized Fields

entities

List<CommonCampaign> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.CommunicationAnsweredEvent

class CommunicationAnsweredEvent extends Object implements Serializable

Serialized Fields

communicationId

String communicationId

conversationId

String conversationId

eventDateTime

Date eventDateTime

eventId

String eventId

Class com.mypurecloud.sdk.v2.model.CommunicationDispositionAppliedEvent

class CommunicationDispositionAppliedEvent extends Object implements Serializable

Serialized Fields

code

String code

communicationId

String communicationId

conversationId

String conversationId

eventDateTime

Date eventDateTime

eventId

String eventId

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.CommunicationEndedEvent

class CommunicationEndedEvent extends Object implements Serializable

Serialized Fields

communicationId

String communicationId

conversationId

String conversationId

destinationConversationId

String destinationConversationId

disconnectType

CommunicationEndedEvent.DisconnectTypeEnum disconnectType

eventDateTime

Date eventDateTime

eventId

String eventId

Class com.mypurecloud.sdk.v2.model.ComparisonPeriod

class ComparisonPeriod extends Object implements Serializable

Serialized Fields

dateEnded

Date dateEnded

dateStarted

Date dateStarted

id

String id

kpi

String kpi

kpiResults

List<KpiResult> kpiResults

percentageBenefit

Double percentageBenefit

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ComparisonPeriodListing

class ComparisonPeriodListing extends Object implements Serializable

Serialized Fields

entities

List<ComparisonPeriod> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ComplexVariableInfo

class ComplexVariableInfo extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.Compliance

class Compliance extends Object implements Serializable

Serialized Fields

helpSettings

List<HelpSettings> helpSettings

optInSettings

List<OptInSettings> optInSettings

stopSettings

List<StopSettings> stopSettings

Class com.mypurecloud.sdk.v2.model.ComplianceResponse

class ComplianceResponse extends Object implements Serializable

Serialized Fields

message

String message

Class com.mypurecloud.sdk.v2.model.Condition

class Condition extends Object implements Serializable

Serialized Fields

agentWrapupField

String agentWrapupField

attributeName

String attributeName

callAnalysisResultField

String callAnalysisResultField

codes

List<String> codes

contactColumnToDataActionFieldMappings

List<ContactColumnToDataActionFieldMapping> contactColumnToDataActionFieldMappings

contactIdField

String contactIdField

dataAction

DomainEntityRef dataAction

dataNotFoundResolution

Boolean dataNotFoundResolution

inverted

Boolean inverted

operator

Condition.OperatorEnum operator

predicates

List<DataActionConditionPredicate> predicates

property

String property

propertyType

Condition.PropertyTypeEnum propertyType

type

Condition.TypeEnum type

value

String value

valueType

Condition.ValueTypeEnum valueType

Class com.mypurecloud.sdk.v2.model.ConditionalGroupRouting

class ConditionalGroupRouting extends Object implements Serializable

Serialized Fields

rules

List<ConditionalGroupRoutingRule> rules

Class com.mypurecloud.sdk.v2.model.ConditionalGroupRoutingRule

class ConditionalGroupRoutingRule extends Object implements Serializable

Serialized Fields

conditionValue

Double conditionValue

groups

List<MemberGroup> groups

metric

ConditionalGroupRoutingRule.MetricEnum metric

operator

ConditionalGroupRoutingRule.OperatorEnum operator

queue

DomainEntityRef queue

waitSeconds

Integer waitSeconds

Class com.mypurecloud.sdk.v2.model.ConfigurationOverrides

class ConfigurationOverrides extends Object implements Serializable

Serialized Fields

priority

Boolean priority

Class com.mypurecloud.sdk.v2.model.ConnectedEdge

class ConnectedEdge extends Object implements Serializable

Serialized Fields

edgeConnectionList

List<EdgeConnectionInfo> edgeConnectionList

id

String id

interfaceIpAddress

String interfaceIpAddress

interfaceName

String interfaceName

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ConnectedQueue

class ConnectedQueue extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ConnectedUser

class ConnectedUser extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ConnectRate

class ConnectRate extends Object implements Serializable

Serialized Fields

attempts

Long attempts

connectRatio

Double connectRatio

connects

Long connects

Class com.mypurecloud.sdk.v2.model.ConstraintConflictMessage

class ConstraintConflictMessage extends Object implements Serializable

Serialized Fields

conflictedConstraintMessages

List<WorkPlanConstraintMessage> conflictedConstraintMessages

message

WorkPlanConstraintConflictMessage message

Class com.mypurecloud.sdk.v2.model.ConsultTransfer

class ConsultTransfer extends Object implements Serializable

Serialized Fields

destination

Destination destination

speakTo

ConsultTransfer.SpeakToEnum speakTo

Class com.mypurecloud.sdk.v2.model.ConsultTransferEvent

class ConsultTransferEvent extends Object implements Serializable

Serialized Fields

conversationId

String conversationId

destinationCommunicationId

String destinationCommunicationId

eventDateTime

Date eventDateTime

eventId

String eventId

initiatingCommunicationId

String initiatingCommunicationId

objectCommunicationId

String objectCommunicationId

Class com.mypurecloud.sdk.v2.model.ConsultTransferResponse

class ConsultTransferResponse extends Object implements Serializable

Serialized Fields

destinationParticipantId

String destinationParticipantId

Class com.mypurecloud.sdk.v2.model.ConsultTransferUpdate

class ConsultTransferUpdate extends Object implements Serializable

Serialized Fields

speakTo

ConsultTransferUpdate.SpeakToEnum speakTo

Class com.mypurecloud.sdk.v2.model.ConsumedResourcesEntityListing

class ConsumedResourcesEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Dependency> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ConsumingResourcesEntityListing

class ConsumingResourcesEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Dependency> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.Contact

class Contact extends Object implements Serializable

Serialized Fields

address

String address

countryCode

String countryCode

display

String display

extension

String extension

integration

String integration

mediaType

Contact.MediaTypeEnum mediaType

type

Contact.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ContactableStatus

class ContactableStatus extends Object implements Serializable

Serialized Fields

columnStatus

Map<String,ColumnStatus> columnStatus

contactable

Boolean contactable

Class com.mypurecloud.sdk.v2.model.ContactAddress

class ContactAddress extends Object implements Serializable

Serialized Fields

address1

String address1

address2

String address2

city

String city

countryCode

String countryCode

postalCode

String postalCode

state

String state

Class com.mypurecloud.sdk.v2.model.ContactAddressableEntityRef

class ContactAddressableEntityRef extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ContactAddressConditionSettings

class ContactAddressConditionSettings extends Object implements Serializable

Serialized Fields

operator

ContactAddressConditionSettings.OperatorEnum operator

value

String value

Class com.mypurecloud.sdk.v2.model.ContactAddressTypeConditionSettings

class ContactAddressTypeConditionSettings extends Object implements Serializable

Serialized Fields

operator

ContactAddressTypeConditionSettings.OperatorEnum operator

value

String value

Class com.mypurecloud.sdk.v2.model.ContactCallbackRequest

class ContactCallbackRequest extends Object implements Serializable

Serialized Fields

campaignId

String campaignId

contactId

String contactId

contactListId

String contactListId

phoneColumn

String phoneColumn

schedule

String schedule

Class com.mypurecloud.sdk.v2.model.ContactCenterSettings

class ContactCenterSettings extends Object implements Serializable

Serialized Fields

removeSkillsFromBlindTransfer

Boolean removeSkillsFromBlindTransfer

Class com.mypurecloud.sdk.v2.model.ContactColumnConditionSettings

class ContactColumnConditionSettings extends Object implements Serializable

Serialized Fields

columnName

String columnName

operator

ContactColumnConditionSettings.OperatorEnum operator

value

String value

valueType

ContactColumnConditionSettings.ValueTypeEnum valueType

Class com.mypurecloud.sdk.v2.model.ContactColumnTimeZone

class ContactColumnTimeZone extends Object implements Serializable

Serialized Fields

columnType

ContactColumnTimeZone.ColumnTypeEnum columnType

timeZone

String timeZone

Class com.mypurecloud.sdk.v2.model.ContactColumnToDataActionFieldMapping

class ContactColumnToDataActionFieldMapping extends Object implements Serializable

Serialized Fields

contactColumnName

String contactColumnName

dataActionField

String dataActionField

Class com.mypurecloud.sdk.v2.model.ContactDetailEventTopicContactUpdateEvent

class ContactDetailEventTopicContactUpdateEvent extends Object implements Serializable

Serialized Fields

addressFrom

String addressFrom

addressTo

String addressTo

ani

String ani

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Integer callbackScheduledTime

callbackUserName

String callbackUserName

conversationExternalContactIds

List<String> conversationExternalContactIds

conversationExternalOrganizationIds

List<String> conversationExternalOrganizationIds

conversationId

String conversationId

direction

ContactDetailEventTopicContactUpdateEvent.DirectionEnum direction

dnis

String dnis

eventTime

Integer eventTime

externalContactId

String externalContactId

externalOrganizationId

String externalOrganizationId

mediaType

ContactDetailEventTopicContactUpdateEvent.MediaTypeEnum mediaType

messageType

ContactDetailEventTopicContactUpdateEvent.MessageTypeEnum messageType

participantId

String participantId

provider

String provider

sessionId

String sessionId

subject

String subject

Class com.mypurecloud.sdk.v2.model.ContactIdentifier

class ContactIdentifier extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

type

ContactIdentifier.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.ContactList

class ContactList extends Object implements Serializable

Serialized Fields

attemptLimits

DomainEntityRef attemptLimits

automaticTimeZoneMapping

Boolean automaticTimeZoneMapping

columnDataTypeSpecifications

List<ColumnDataTypeSpecification> columnDataTypeSpecifications

columnNames

List<String> columnNames

dateCreated

Date dateCreated

dateModified

Date dateModified

division

DomainEntityRef division

emailColumns

List<EmailColumn> emailColumns

id

String id

importStatus

ImportStatus importStatus

name

String name

phoneColumns

List<ContactPhoneNumberColumn> phoneColumns

previewModeAcceptedValues

List<String> previewModeAcceptedValues

previewModeColumnName

String previewModeColumnName

selfUri

String selfUri

size

Long size

version

Integer version

zipCodeColumnName

String zipCodeColumnName

Class com.mypurecloud.sdk.v2.model.ContactListDivisionView

class ContactListDivisionView extends Object implements Serializable

Serialized Fields

columnNames

List<String> columnNames

division

Division division

emailColumns

List<EmailColumn> emailColumns

id

String id

importStatus

ImportStatus importStatus

name

String name

phoneColumns

List<ContactPhoneNumberColumn> phoneColumns

selfUri

String selfUri

size

Long size

Class com.mypurecloud.sdk.v2.model.ContactListDivisionViewListing

class ContactListDivisionViewListing extends Object implements Serializable

Serialized Fields

entities

List<ContactListDivisionView> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ContactlistDownloadReadyExportUri

class ContactlistDownloadReadyExportUri extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

exportTimestamp

String exportTimestamp

uri

String uri

Class com.mypurecloud.sdk.v2.model.ContactlistDownloadReadyObject

class ContactlistDownloadReadyObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.ContactListEntityListing

class ContactListEntityListing extends Object implements Serializable

Serialized Fields

entities

List<ContactList> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ContactListFilter

class ContactListFilter extends Object implements Serializable

Serialized Fields

clauses

List<ContactListFilterClause> clauses

contactList

DomainEntityRef contactList

dateCreated

Date dateCreated

dateModified

Date dateModified

filterType

ContactListFilter.FilterTypeEnum filterType

id

String id

name

String name

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.ContactListFilterClause

class ContactListFilterClause extends Object implements Serializable

Serialized Fields

filterType

ContactListFilterClause.FilterTypeEnum filterType

predicates

List<ContactListFilterPredicate> predicates

Class com.mypurecloud.sdk.v2.model.ContactListFilterEntityListing

class ContactListFilterEntityListing extends Object implements Serializable

Serialized Fields

entities

List<ContactListFilter> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ContactListFilterPredicate

class ContactListFilterPredicate extends Object implements Serializable

Serialized Fields

column

String column

columnType

ContactListFilterPredicate.ColumnTypeEnum columnType

inverted

Boolean inverted

operator

ContactListFilterPredicate.OperatorEnum operator

range

ContactListFilterRange range

value

String value

Class com.mypurecloud.sdk.v2.model.ContactListFilterRange

class ContactListFilterRange extends Object implements Serializable

Serialized Fields

inSet

List<String> inSet

max

String max

maxInclusive

Boolean maxInclusive

min

String min

minInclusive

Boolean minInclusive

Class com.mypurecloud.sdk.v2.model.ContactlistImportStatusImportStatus

class ContactlistImportStatusImportStatus extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

completedRecords

Integer completedRecords

failureReason

String failureReason

importState

ContactlistImportStatusImportStatus.ImportStateEnum importState

percentageComplete

Integer percentageComplete

totalRecords

Integer totalRecords

Class com.mypurecloud.sdk.v2.model.ContactlistImportStatusObject

class ContactlistImportStatusObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.ContactListing

class ContactListing extends Object implements Serializable

Serialized Fields

entities

List<ExternalContact> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

partialResults

Boolean partialResults

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ContactPhoneNumberColumn

class ContactPhoneNumberColumn extends Object implements Serializable

Serialized Fields

callableTimeColumn

String callableTimeColumn

columnName

String columnName

type

String type

Class com.mypurecloud.sdk.v2.model.ContactSort

class ContactSort extends Object implements Serializable

Serialized Fields

direction

ContactSort.DirectionEnum direction

fieldName

String fieldName

numeric

Boolean numeric

Class com.mypurecloud.sdk.v2.model.ContentActions

class ContentActions extends Object implements Serializable

Serialized Fields

textback

String textback

url

String url

urlTarget

String urlTarget

Class com.mypurecloud.sdk.v2.model.ContentAttachment

class ContentAttachment extends Object implements Serializable

Serialized Fields

filename

String filename

id

String id

mediaType

ContentAttachment.MediaTypeEnum mediaType

mime

String mime

sha256

String sha256

text

String text

url

String url

Class com.mypurecloud.sdk.v2.model.ContentAttributeFilterItem

class ContentAttributeFilterItem extends Object implements Serializable

Serialized Fields

id

String id

operator

ContentAttributeFilterItem.OperatorEnum operator

values

List<String> values

Class com.mypurecloud.sdk.v2.model.ContentButtonResponse

class ContentButtonResponse extends Object implements Serializable

Serialized Fields

id

String id

payload

String payload

text

String text

type

ContentButtonResponse.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ContentCard

class ContentCard extends Object implements Serializable

Serialized Fields

actions

List<ContentCardAction> actions

defaultAction

ContentCardAction defaultAction

description

String description

image

String image

title

String title

video

String video

Class com.mypurecloud.sdk.v2.model.ContentCardAction

class ContentCardAction extends Object implements Serializable

Serialized Fields

payload

String payload

text

String text

type

ContentCardAction.TypeEnum type

url

String url

Class com.mypurecloud.sdk.v2.model.ContentCarousel

class ContentCarousel extends Object implements Serializable

Serialized Fields

cards

List<ContentCard> cards

Class com.mypurecloud.sdk.v2.model.ContentFacetFilterItem

class ContentFacetFilterItem extends Object implements Serializable

Serialized Fields

name

String name

operator

ContentFacetFilterItem.OperatorEnum operator

type

ContentFacetFilterItem.TypeEnum type

values

List<String> values

Class com.mypurecloud.sdk.v2.model.ContentFilterItem

class ContentFilterItem extends Object implements Serializable

Serialized Fields

name

String name

operator

ContentFilterItem.OperatorEnum operator

type

ContentFilterItem.TypeEnum type

values

List<String> values

Class com.mypurecloud.sdk.v2.model.ContentGeneric

class ContentGeneric extends Object implements Serializable

Serialized Fields

actions

ContentActions actions

components

List<ButtonComponent> components

description

String description

image

String image

title

String title

video

String video

Class com.mypurecloud.sdk.v2.model.ContentList

class ContentList extends Object implements Serializable

Serialized Fields

actions

ContentActions actions

components

List<ListItemComponent> components

description

String description

id

String id

listType

ContentList.ListTypeEnum listType

submitLabel

String submitLabel

title

String title

Class com.mypurecloud.sdk.v2.model.ContentLocation

class ContentLocation extends Object implements Serializable

Serialized Fields

address

String address

latitude

Double latitude

longitude

Double longitude

text

String text

url

String url

Class com.mypurecloud.sdk.v2.model.ContentManagementSingleDocumentTopicDocumentDataV2

class ContentManagementSingleDocumentTopicDocumentDataV2 extends Object implements Serializable

Serialized Fields

changeNumber

Integer changeNumber

contentLength

Integer contentLength

contentType

String contentType

createdBy

ContentManagementSingleDocumentTopicUserData createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

dateUploaded

Date dateUploaded

filename

String filename

id

String id

lockInfo

ContentManagementSingleDocumentTopicLockData lockInfo

name

String name

selfUri

String selfUri

uploadedBy

ContentManagementSingleDocumentTopicUserData uploadedBy

workspace

ContentManagementSingleDocumentTopicWorkspaceData workspace

Class com.mypurecloud.sdk.v2.model.ContentManagementSingleDocumentTopicLockData

class ContentManagementSingleDocumentTopicLockData extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateExpires

Date dateExpires

lockedBy

ContentManagementSingleDocumentTopicUserData lockedBy

Class com.mypurecloud.sdk.v2.model.ContentManagementSingleDocumentTopicUserData

class ContentManagementSingleDocumentTopicUserData extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ContentManagementSingleDocumentTopicWorkspaceData

class ContentManagementSingleDocumentTopicWorkspaceData extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.ContentManagementWorkspaceDocumentsTopicDocumentDataV2

class ContentManagementWorkspaceDocumentsTopicDocumentDataV2 extends Object implements Serializable

Serialized Fields

changeNumber

Integer changeNumber

contentLength

Integer contentLength

contentType

String contentType

createdBy

ContentManagementWorkspaceDocumentsTopicUserData createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

dateUploaded

Date dateUploaded

filename

String filename

id

String id

lockInfo

ContentManagementWorkspaceDocumentsTopicLockData lockInfo

name

String name

selfUri

String selfUri

uploadedBy

ContentManagementWorkspaceDocumentsTopicUserData uploadedBy

workspace

ContentManagementWorkspaceDocumentsTopicWorkspaceData workspace

Class com.mypurecloud.sdk.v2.model.ContentManagementWorkspaceDocumentsTopicLockData

class ContentManagementWorkspaceDocumentsTopicLockData extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateExpires

Date dateExpires

lockedBy

ContentManagementWorkspaceDocumentsTopicUserData lockedBy

Class com.mypurecloud.sdk.v2.model.ContentManagementWorkspaceDocumentsTopicUserData

class ContentManagementWorkspaceDocumentsTopicUserData extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ContentManagementWorkspaceDocumentsTopicWorkspaceData

class ContentManagementWorkspaceDocumentsTopicWorkspaceData extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.ContentNotificationTemplate

class ContentNotificationTemplate extends Object implements Serializable

Serialized Fields

body

NotificationTemplateBody body

footer

NotificationTemplateFooter footer

header

NotificationTemplateHeader header

id

String id

language

String language

Class com.mypurecloud.sdk.v2.model.ContentOffer

class ContentOffer extends Object implements Serializable

Serialized Fields

body

String body

callToAction

CallToAction callToAction

displayMode

ContentOffer.DisplayModeEnum displayMode

headline

String headline

imageUrl

String imageUrl

layoutMode

ContentOffer.LayoutModeEnum layoutMode

style

ContentOfferStylingConfiguration style

title

String title

Class com.mypurecloud.sdk.v2.model.ContentOfferStyleProperties

class ContentOfferStyleProperties extends Object implements Serializable

Serialized Fields

backgroundColor

String backgroundColor

color

String color

padding

String padding

Class com.mypurecloud.sdk.v2.model.ContentOfferStylingConfiguration

class ContentOfferStylingConfiguration extends Object implements Serializable

Serialized Fields

body

TextStyleProperties body

closeButton

CloseButtonStyleProperties closeButton

ctaButton

CtaButtonStyleProperties ctaButton

headline

TextStyleProperties headline

offer

ContentOfferStyleProperties offer

position

ContentPositionProperties position

title

TextStyleProperties title

Class com.mypurecloud.sdk.v2.model.ContentPositionProperties

class ContentPositionProperties extends Object implements Serializable

Serialized Fields

bottom

String bottom

left

String left

right

String right

top

String top

Class com.mypurecloud.sdk.v2.model.ContentPostback

class ContentPostback extends Object implements Serializable

Serialized Fields

id

String id

payload

String payload

text

String text

Class com.mypurecloud.sdk.v2.model.ContentQueryRequest

class ContentQueryRequest extends Object implements Serializable

Serialized Fields

attributeFilters

List<ContentAttributeFilterItem> attributeFilters

facetNameRequests

List<String> facetNameRequests

filters

List<ContentFacetFilterItem> filters

includeShares

Boolean includeShares

pageNumber

Integer pageNumber

pageSize

Integer pageSize

queryPhrase

String queryPhrase

sort

List<ContentSortItem> sort

Class com.mypurecloud.sdk.v2.model.ContentQuickReply

class ContentQuickReply extends Object implements Serializable

Serialized Fields

action

ContentQuickReply.ActionEnum action

id

String id

image

String image

payload

String payload

text

String text

Class com.mypurecloud.sdk.v2.model.ContentQuickReplyV2

class ContentQuickReplyV2 extends Object implements Serializable

Serialized Fields

actions

List<ContentQuickReply> actions

title

String title

Class com.mypurecloud.sdk.v2.model.ContentReaction

class ContentReaction extends Object implements Serializable

Serialized Fields

count

Integer count

reactionType

ContentReaction.ReactionTypeEnum reactionType

Class com.mypurecloud.sdk.v2.model.ContentSetting

class ContentSetting extends Object implements Serializable

Serialized Fields

story

StorySetting story

Class com.mypurecloud.sdk.v2.model.ContentSortItem

class ContentSortItem extends Object implements Serializable

Serialized Fields

ascending

Boolean ascending

name

String name

Class com.mypurecloud.sdk.v2.model.ContentStory

class ContentStory extends Object implements Serializable

Serialized Fields

replyToId

String replyToId

type

ContentStory.TypeEnum type

url

String url

Class com.mypurecloud.sdk.v2.model.ContentText

class ContentText extends Object implements Serializable

Serialized Fields

body

String body

type

ContentText.TypeEnum type

Class com.mypurecloud.sdk.v2.model.Context

class Context extends Object implements Serializable

Serialized Fields

patterns

List<ContextPattern> patterns

Class com.mypurecloud.sdk.v2.model.ContextEntity

class ContextEntity extends Object implements Serializable

Serialized Fields

name

String name

Class com.mypurecloud.sdk.v2.model.ContextIntent

class ContextIntent extends Object implements Serializable

Serialized Fields

name

String name

Class com.mypurecloud.sdk.v2.model.ContextPattern

class ContextPattern extends Object implements Serializable

Serialized Fields

criteria

List<EntityTypeCriteria> criteria

Class com.mypurecloud.sdk.v2.model.Conversation

class Conversation extends Object implements Serializable

Serialized Fields

address

String address

conversationIds

List<String> conversationIds

divisions

List<ConversationDivisionMembership> divisions

endTime

Date endTime

externalTag

String externalTag

id

String id

maxParticipants

Integer maxParticipants

name

String name

participants

List<Participant> participants

recentTransfers

List<TransferResponse> recentTransfers

recordingState

Conversation.RecordingStateEnum recordingState

securePause

Boolean securePause

selfUri

String selfUri

startTime

Date startTime

state

Conversation.StateEnum state

Class com.mypurecloud.sdk.v2.model.ConversationActivityData

class ConversationActivityData extends Object implements Serializable

Serialized Fields

data

List<ConversationActivityMetricValue> data

entities

List<ConversationActivityEntityData> entities

group

Map<String,String> group

truncated

Boolean truncated

Class com.mypurecloud.sdk.v2.model.ConversationActivityEntityData

class ConversationActivityEntityData extends Object implements Serializable

Serialized Fields

activityDate

Date activityDate

addressFrom

String addressFrom

addressTo

String addressTo

ani

String ani

conversationId

String conversationId

convertedFrom

String convertedFrom

convertedTo

String convertedTo

direction

ConversationActivityEntityData.DirectionEnum direction

dnis

String dnis

mediaType

ConversationActivityEntityData.MediaTypeEnum mediaType

metric

ConversationActivityEntityData.MetricEnum metric

participantName

String participantName

queueId

String queueId

requestedLanguageId

String requestedLanguageId

requestedRoutings

List<ConversationActivityEntityData.RequestedRoutingsEnum> requestedRoutings

requestedRoutingSkillIds

List<String> requestedRoutingSkillIds

routingPriority

Long routingPriority

scoredAgents

List<ConversationActivityScoredAgent> scoredAgents

sessionId

String sessionId

teamId

String teamId

usedRouting

ConversationActivityEntityData.UsedRoutingEnum usedRouting

userId

String userId

Class com.mypurecloud.sdk.v2.model.ConversationActivityMetricValue

class ConversationActivityMetricValue extends Object implements Serializable

Serialized Fields

count

Integer count

metric

ConversationActivityMetricValue.MetricEnum metric

Class com.mypurecloud.sdk.v2.model.ConversationActivityQuery

class ConversationActivityQuery extends Object implements Serializable

Serialized Fields

filter

ConversationActivityQueryFilter filter

groupBy

List<ConversationActivityQuery.GroupByEnum> groupBy

metrics

List<ConversationActivityQueryMetric> metrics

order

ConversationActivityQuery.OrderEnum order

Class com.mypurecloud.sdk.v2.model.ConversationActivityQueryClause

class ConversationActivityQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<ConversationActivityQueryPredicate> predicates

type

ConversationActivityQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ConversationActivityQueryFilter

class ConversationActivityQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<ConversationActivityQueryClause> clauses

predicates

List<ConversationActivityQueryPredicate> predicates

type

ConversationActivityQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ConversationActivityQueryMetric

class ConversationActivityQueryMetric extends Object implements Serializable

Serialized Fields

details

Boolean details

metric

ConversationActivityQueryMetric.MetricEnum metric

Class com.mypurecloud.sdk.v2.model.ConversationActivityQueryPredicate

class ConversationActivityQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

ConversationActivityQueryPredicate.DimensionEnum dimension

operator

ConversationActivityQueryPredicate.OperatorEnum operator

type

ConversationActivityQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.ConversationActivityResponse

class ConversationActivityResponse extends Object implements Serializable

Serialized Fields

entityIdDimension

ConversationActivityResponse.EntityIdDimensionEnum entityIdDimension

results

List<ConversationActivityData> results

Class com.mypurecloud.sdk.v2.model.ConversationActivityScoredAgent

class ConversationActivityScoredAgent extends Object implements Serializable

Serialized Fields

agentScore

Integer agentScore

scoredAgentId

String scoredAgentId

Class com.mypurecloud.sdk.v2.model.ConversationAggregateDataContainer

class ConversationAggregateDataContainer extends Object implements Serializable

Serialized Fields

data

List<StatisticalResponse> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.ConversationAggregateQueryClause

class ConversationAggregateQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<ConversationAggregateQueryPredicate> predicates

type

ConversationAggregateQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ConversationAggregateQueryFilter

class ConversationAggregateQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<ConversationAggregateQueryClause> clauses

predicates

List<ConversationAggregateQueryPredicate> predicates

type

ConversationAggregateQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ConversationAggregateQueryPredicate

class ConversationAggregateQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

ConversationAggregateQueryPredicate.DimensionEnum dimension

operator

ConversationAggregateQueryPredicate.OperatorEnum operator

range

NumericRange range

type

ConversationAggregateQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.ConversationAggregateQueryResponse

class ConversationAggregateQueryResponse extends Object implements Serializable

Serialized Fields

results

List<ConversationAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.ConversationAggregationQuery

class ConversationAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

ConversationAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

ConversationAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<ConversationAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<ConversationAggregationQuery.MetricsEnum> metrics

timeZone

String timeZone

views

List<ConversationAggregationView> views

Class com.mypurecloud.sdk.v2.model.ConversationAggregationView

class ConversationAggregationView extends Object implements Serializable

Serialized Fields

function

ConversationAggregationView.FunctionEnum function

name

String name

range

AggregationRange range

target

ConversationAggregationView.TargetEnum target

Class com.mypurecloud.sdk.v2.model.ConversationAppSettings

class ConversationAppSettings extends Object implements Serializable

Serialized Fields

autoStart

AutoStart autoStart

autoStartType

ConversationAppSettings.AutoStartTypeEnum autoStartType

conversationClear

ConversationClearSettings conversationClear

conversationDisconnect

ConversationDisconnectSettings conversationDisconnect

enabled

Boolean enabled

humanize

Humanize humanize

markdown

Markdown markdown

showAgentTypingIndicator

Boolean showAgentTypingIndicator

showUserTypingIndicator

Boolean showUserTypingIndicator

Class com.mypurecloud.sdk.v2.model.ConversationAssociation

class ConversationAssociation extends Object implements Serializable

Serialized Fields

communicationId

String communicationId

conversationId

String conversationId

externalContactId

String externalContactId

mediaType

ConversationAssociation.MediaTypeEnum mediaType

Class com.mypurecloud.sdk.v2.model.ConversationAsyncAggregateQueryResponse

class ConversationAsyncAggregateQueryResponse extends Object implements Serializable

Serialized Fields

cursor

String cursor

results

List<ConversationAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.ConversationAsyncAggregationQuery

class ConversationAsyncAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

ConversationAsyncAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

ConversationAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<ConversationAsyncAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<ConversationAsyncAggregationQuery.MetricsEnum> metrics

pageSize

Integer pageSize

timeZone

String timeZone

views

List<ConversationAggregationView> views

Class com.mypurecloud.sdk.v2.model.ConversationBasic

class ConversationBasic extends Object implements Serializable

Serialized Fields

divisions

List<ConversationDivisionMembership> divisions

endTime

Date endTime

externalTag

String externalTag

id

String id

name

String name

participants

List<ParticipantBasic> participants

securePause

Boolean securePause

selfUri

String selfUri

startTime

Date startTime

Class com.mypurecloud.sdk.v2.model.ConversationCallbackEventTopicCallbackConversation

class ConversationCallbackEventTopicCallbackConversation extends Object implements Serializable

Serialized Fields

id

String id

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<ConversationCallbackEventTopicCallbackMediaParticipant> participants

Class com.mypurecloud.sdk.v2.model.ConversationCallbackEventTopicCallbackMediaParticipant

class ConversationCallbackEventTopicCallbackMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

automatedCallbackConfigId

String automatedCallbackConfigId

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Date callbackScheduledTime

callbackUserName

String callbackUserName

connectedTime

Date connectedTime

conversationRoutingData

ConversationCallbackEventTopicConversationRoutingData conversationRoutingData

direction

ConversationCallbackEventTopicCallbackMediaParticipant.DirectionEnum direction

disconnectType

ConversationCallbackEventTopicCallbackMediaParticipant.DisconnectTypeEnum disconnectType

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

ConversationCallbackEventTopicErrorBody errorInfo

externalCampaign

Boolean externalCampaign

externalContact

ConversationCallbackEventTopicUriReference externalContact

externalOrganization

ConversationCallbackEventTopicUriReference externalOrganization

flaggedReason

ConversationCallbackEventTopicCallbackMediaParticipant.FlaggedReasonEnum flaggedReason

held

Boolean held

id

String id

initialState

ConversationCallbackEventTopicCallbackMediaParticipant.InitialStateEnum initialState

journeyContext

ConversationCallbackEventTopicJourneyContext journeyContext

mediaRoles

List<String> mediaRoles

name

String name

outboundPreview

ConversationCallbackEventTopicDialerPreview outboundPreview

peer

String peer

provider

String provider

purpose

String purpose

queue

ConversationCallbackEventTopicUriReference queue

screenRecordingState

String screenRecordingState

script

ConversationCallbackEventTopicUriReference script

skipEnabled

Boolean skipEnabled

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

ConversationCallbackEventTopicCallbackMediaParticipant.StateEnum state

team

ConversationCallbackEventTopicUriReference team

timeoutSeconds

Integer timeoutSeconds

user

ConversationCallbackEventTopicUriReference user

voicemail

ConversationCallbackEventTopicVoicemail voicemail

wrapup

ConversationCallbackEventTopicWrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.ConversationCallbackEventTopicConversationRoutingData

class ConversationCallbackEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

ConversationCallbackEventTopicUriReference language

priority

Integer priority

queue

ConversationCallbackEventTopicUriReference queue

scoredAgents

List<ConversationCallbackEventTopicScoredAgent> scoredAgents

skills

List<ConversationCallbackEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.ConversationCallbackEventTopicDetail

class ConversationCallbackEventTopicDetail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.ConversationCallbackEventTopicDialerPreview

class ConversationCallbackEventTopicDialerPreview extends Object implements Serializable

Serialized Fields

campaignId

String campaignId

contactId

String contactId

contactListId

String contactListId

id

String id

phoneNumberColumns

List<ConversationCallbackEventTopicPhoneNumberColumn> phoneNumberColumns

Class com.mypurecloud.sdk.v2.model.ConversationCallbackEventTopicErrorBody

class ConversationCallbackEventTopicErrorBody extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

details

List<ConversationCallbackEventTopicDetail> details

entityId

String entityId

entityName

String entityName

errors

List<ConversationCallbackEventTopicErrorBody> errors

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.ConversationCallbackEventTopicJourneyAction

class ConversationCallbackEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

ConversationCallbackEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.ConversationCallbackEventTopicJourneyActionMap

class ConversationCallbackEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.ConversationCallbackEventTopicJourneyContext

class ConversationCallbackEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

ConversationCallbackEventTopicJourneyCustomer customer

customerSession

ConversationCallbackEventTopicJourneyCustomerSession customerSession

triggeringAction

ConversationCallbackEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.ConversationCallbackEventTopicJourneyCustomer

class ConversationCallbackEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.ConversationCallbackEventTopicJourneyCustomerSession

class ConversationCallbackEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.ConversationCallbackEventTopicPhoneNumberColumn

class ConversationCallbackEventTopicPhoneNumberColumn extends Object implements Serializable

Serialized Fields

columnName

String columnName

type

String type

Class com.mypurecloud.sdk.v2.model.ConversationCallbackEventTopicScoredAgent

class ConversationCallbackEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

ConversationCallbackEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.ConversationCallbackEventTopicUriReference

class ConversationCallbackEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ConversationCallbackEventTopicVoicemail

class ConversationCallbackEventTopicVoicemail extends Object implements Serializable

Serialized Fields

id

String id

uploadStatus

ConversationCallbackEventTopicVoicemail.UploadStatusEnum uploadStatus

Class com.mypurecloud.sdk.v2.model.ConversationCallbackEventTopicWrapup

class ConversationCallbackEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.ConversationCallEventTopicCallConversation

class ConversationCallEventTopicCallConversation extends Object implements Serializable

Serialized Fields

id

String id

maxParticipants

Integer maxParticipants

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<ConversationCallEventTopicCallMediaParticipant> participants

recordingState

ConversationCallEventTopicCallConversation.RecordingStateEnum recordingState

securePause

Boolean securePause

Class com.mypurecloud.sdk.v2.model.ConversationCallEventTopicCallMediaParticipant

class ConversationCallEventTopicCallMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

ani

String ani

attributes

Map<String,String> attributes

bargedParticipantId

String bargedParticipantId

bargedTime

Date bargedTime

coachedParticipantId

String coachedParticipantId

confined

Boolean confined

connectedTime

Date connectedTime

consultParticipantId

String consultParticipantId

conversationRoutingData

ConversationCallEventTopicConversationRoutingData conversationRoutingData

direction

ConversationCallEventTopicCallMediaParticipant.DirectionEnum direction

disconnectType

ConversationCallEventTopicCallMediaParticipant.DisconnectTypeEnum disconnectType

dnis

String dnis

documentId

String documentId

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

ConversationCallEventTopicErrorBody errorInfo

externalContact

ConversationCallEventTopicUriReference externalContact

externalOrganization

ConversationCallEventTopicUriReference externalOrganization

faxStatus

ConversationCallEventTopicFaxStatus faxStatus

flaggedReason

ConversationCallEventTopicCallMediaParticipant.FlaggedReasonEnum flaggedReason

group

ConversationCallEventTopicUriReference group

held

Boolean held

id

String id

initialState

ConversationCallEventTopicCallMediaParticipant.InitialStateEnum initialState

journeyContext

ConversationCallEventTopicJourneyContext journeyContext

mediaRoles

List<String> mediaRoles

monitoredParticipantId

String monitoredParticipantId

muted

Boolean muted

name

String name

peer

String peer

provider

String provider

purpose

String purpose

queue

ConversationCallEventTopicUriReference queue

recording

Boolean recording

recordingState

ConversationCallEventTopicCallMediaParticipant.RecordingStateEnum recordingState

screenRecordingState

String screenRecordingState

script

ConversationCallEventTopicUriReference script

securePause

Boolean securePause

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

ConversationCallEventTopicCallMediaParticipant.StateEnum state

team

ConversationCallEventTopicUriReference team

user

ConversationCallEventTopicUriReference user

wrapup

ConversationCallEventTopicWrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.ConversationCallEventTopicConversationRoutingData

class ConversationCallEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

ConversationCallEventTopicUriReference language

priority

Integer priority

queue

ConversationCallEventTopicUriReference queue

scoredAgents

List<ConversationCallEventTopicScoredAgent> scoredAgents

skills

List<ConversationCallEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.ConversationCallEventTopicDetail

class ConversationCallEventTopicDetail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.ConversationCallEventTopicErrorBody

class ConversationCallEventTopicErrorBody extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

details

List<ConversationCallEventTopicDetail> details

entityId

String entityId

entityName

String entityName

errors

List<ConversationCallEventTopicErrorBody> errors

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.ConversationCallEventTopicFaxStatus

class ConversationCallEventTopicFaxStatus extends Object implements Serializable

Serialized Fields

activePage

Integer activePage

bytesTransmitted

Integer bytesTransmitted

dataRate

Integer dataRate

direction

String direction

expectedPages

Integer expectedPages

lineErrors

Integer lineErrors

linesTransmitted

Integer linesTransmitted

pageErrors

Integer pageErrors

Class com.mypurecloud.sdk.v2.model.ConversationCallEventTopicJourneyAction

class ConversationCallEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

ConversationCallEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.ConversationCallEventTopicJourneyActionMap

class ConversationCallEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.ConversationCallEventTopicJourneyContext

class ConversationCallEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

ConversationCallEventTopicJourneyCustomer customer

customerSession

ConversationCallEventTopicJourneyCustomerSession customerSession

triggeringAction

ConversationCallEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.ConversationCallEventTopicJourneyCustomer

class ConversationCallEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.ConversationCallEventTopicJourneyCustomerSession

class ConversationCallEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.ConversationCallEventTopicScoredAgent

class ConversationCallEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

ConversationCallEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.ConversationCallEventTopicUriReference

class ConversationCallEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ConversationCallEventTopicWrapup

class ConversationCallEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.ConversationChannel

class ConversationChannel extends Object implements Serializable

Serialized Fields

messageType

ConversationChannel.MessageTypeEnum messageType

platform

String platform

type

ConversationChannel.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ConversationChannelMetadata

class ConversationChannelMetadata extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.ConversationChat

class ConversationChat extends Object implements Serializable

Serialized Fields

afterCallWork

AfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

avatarImageUrl

String avatarImageUrl

connectedTime

Date connectedTime

direction

ConversationChat.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectType

ConversationChat.DisconnectTypeEnum disconnectType

held

Boolean held

id

String id

initialState

ConversationChat.InitialStateEnum initialState

journeyContext

JourneyContext journeyContext

peerId

String peerId

provider

String provider

recordingId

String recordingId

roomId

String roomId

scriptId

String scriptId

segments

List<Segment> segments

startAlertingTime

Date startAlertingTime

startHoldTime

Date startHoldTime

state

ConversationChat.StateEnum state

wrapup

Wrapup wrapup

Class com.mypurecloud.sdk.v2.model.ConversationChatEventTopicChatConversation

class ConversationChatEventTopicChatConversation extends Object implements Serializable

Serialized Fields

id

String id

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<ConversationChatEventTopicChatMediaParticipant> participants

Class com.mypurecloud.sdk.v2.model.ConversationChatEventTopicChatMediaParticipant

class ConversationChatEventTopicChatMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

avatarImageUrl

String avatarImageUrl

connectedTime

Date connectedTime

conversationRoutingData

ConversationChatEventTopicConversationRoutingData conversationRoutingData

direction

ConversationChatEventTopicChatMediaParticipant.DirectionEnum direction

disconnectType

ConversationChatEventTopicChatMediaParticipant.DisconnectTypeEnum disconnectType

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

ConversationChatEventTopicErrorBody errorInfo

externalContact

ConversationChatEventTopicUriReference externalContact

externalOrganization

ConversationChatEventTopicUriReference externalOrganization

flaggedReason

ConversationChatEventTopicChatMediaParticipant.FlaggedReasonEnum flaggedReason

held

Boolean held

id

String id

initialState

ConversationChatEventTopicChatMediaParticipant.InitialStateEnum initialState

journeyContext

ConversationChatEventTopicJourneyContext journeyContext

mediaRoles

List<String> mediaRoles

name

String name

peer

String peer

provider

String provider

purpose

String purpose

queue

ConversationChatEventTopicUriReference queue

roomId

String roomId

screenRecordingState

String screenRecordingState

script

ConversationChatEventTopicUriReference script

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

ConversationChatEventTopicChatMediaParticipant.StateEnum state

team

ConversationChatEventTopicUriReference team

user

ConversationChatEventTopicUriReference user

wrapup

ConversationChatEventTopicWrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.ConversationChatEventTopicConversationRoutingData

class ConversationChatEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

ConversationChatEventTopicUriReference language

priority

Integer priority

queue

ConversationChatEventTopicUriReference queue

scoredAgents

List<ConversationChatEventTopicScoredAgent> scoredAgents

skills

List<ConversationChatEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.ConversationChatEventTopicDetail

class ConversationChatEventTopicDetail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.ConversationChatEventTopicErrorBody

class ConversationChatEventTopicErrorBody extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

details

List<ConversationChatEventTopicDetail> details

entityId

String entityId

entityName

String entityName

errors

List<ConversationChatEventTopicErrorBody> errors

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.ConversationChatEventTopicJourneyAction

class ConversationChatEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

ConversationChatEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.ConversationChatEventTopicJourneyActionMap

class ConversationChatEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.ConversationChatEventTopicJourneyContext

class ConversationChatEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

ConversationChatEventTopicJourneyCustomer customer

customerSession

ConversationChatEventTopicJourneyCustomerSession customerSession

triggeringAction

ConversationChatEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.ConversationChatEventTopicJourneyCustomer

class ConversationChatEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.ConversationChatEventTopicJourneyCustomerSession

class ConversationChatEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.ConversationChatEventTopicScoredAgent

class ConversationChatEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

ConversationChatEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.ConversationChatEventTopicUriReference

class ConversationChatEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ConversationChatEventTopicWrapup

class ConversationChatEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.ConversationClearSettings

class ConversationClearSettings extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

Class com.mypurecloud.sdk.v2.model.ConversationCobrowseEventTopicCobrowseConversation

class ConversationCobrowseEventTopicCobrowseConversation extends Object implements Serializable

Serialized Fields

id

String id

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<ConversationCobrowseEventTopicCobrowseMediaParticipant> participants

Class com.mypurecloud.sdk.v2.model.ConversationCobrowseEventTopicCobrowseMediaParticipant

class ConversationCobrowseEventTopicCobrowseMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

cobrowseRole

String cobrowseRole

cobrowseSessionId

String cobrowseSessionId

connectedTime

Date connectedTime

controlling

List<String> controlling

conversationRoutingData

ConversationCobrowseEventTopicConversationRoutingData conversationRoutingData

direction

ConversationCobrowseEventTopicCobrowseMediaParticipant.DirectionEnum direction

disconnectType

ConversationCobrowseEventTopicCobrowseMediaParticipant.DisconnectTypeEnum disconnectType

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

ConversationCobrowseEventTopicErrorBody errorInfo

externalContact

ConversationCobrowseEventTopicUriReference externalContact

externalOrganization

ConversationCobrowseEventTopicUriReference externalOrganization

flaggedReason

ConversationCobrowseEventTopicCobrowseMediaParticipant.FlaggedReasonEnum flaggedReason

held

Boolean held

id

String id

initialState

ConversationCobrowseEventTopicCobrowseMediaParticipant.InitialStateEnum initialState

journeyContext

ConversationCobrowseEventTopicJourneyContext journeyContext

mediaRoles

List<String> mediaRoles

name

String name

peer

String peer

provider

String provider

providerEventTime

Date providerEventTime

purpose

String purpose

queue

ConversationCobrowseEventTopicUriReference queue

screenRecordingState

String screenRecordingState

script

ConversationCobrowseEventTopicUriReference script

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

ConversationCobrowseEventTopicCobrowseMediaParticipant.StateEnum state

team

ConversationCobrowseEventTopicUriReference team

user

ConversationCobrowseEventTopicUriReference user

viewerUrl

String viewerUrl

wrapup

ConversationCobrowseEventTopicWrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.ConversationCobrowseEventTopicConversationRoutingData

class ConversationCobrowseEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

ConversationCobrowseEventTopicUriReference language

priority

Integer priority

queue

ConversationCobrowseEventTopicUriReference queue

scoredAgents

List<ConversationCobrowseEventTopicScoredAgent> scoredAgents

skills

List<ConversationCobrowseEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.ConversationCobrowseEventTopicDetail

class ConversationCobrowseEventTopicDetail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.ConversationCobrowseEventTopicErrorBody

class ConversationCobrowseEventTopicErrorBody extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

details

List<ConversationCobrowseEventTopicDetail> details

entityId

String entityId

entityName

String entityName

errors

List<ConversationCobrowseEventTopicErrorBody> errors

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.ConversationCobrowseEventTopicJourneyAction

class ConversationCobrowseEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

ConversationCobrowseEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.ConversationCobrowseEventTopicJourneyActionMap

class ConversationCobrowseEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.ConversationCobrowseEventTopicJourneyContext

class ConversationCobrowseEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

ConversationCobrowseEventTopicJourneyCustomer customer

customerSession

ConversationCobrowseEventTopicJourneyCustomerSession customerSession

triggeringAction

ConversationCobrowseEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.ConversationCobrowseEventTopicJourneyCustomer

class ConversationCobrowseEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.ConversationCobrowseEventTopicJourneyCustomerSession

class ConversationCobrowseEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.ConversationCobrowseEventTopicScoredAgent

class ConversationCobrowseEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

ConversationCobrowseEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.ConversationCobrowseEventTopicUriReference

class ConversationCobrowseEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ConversationCobrowseEventTopicWrapup

class ConversationCobrowseEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.ConversationContentAttachment

class ConversationContentAttachment extends Object implements Serializable

Serialized Fields

contentSizeBytes

Long contentSizeBytes

filename

String filename

id

String id

mediaType

ConversationContentAttachment.MediaTypeEnum mediaType

mime

String mime

sha256

String sha256

text

String text

url

String url

Class com.mypurecloud.sdk.v2.model.ConversationContentButtonResponse

class ConversationContentButtonResponse extends Object implements Serializable

Serialized Fields

payload

String payload

text

String text

type

ConversationContentButtonResponse.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ConversationContentCard

class ConversationContentCard extends Object implements Serializable

Serialized Fields

actions

List<ConversationContentCardAction> actions

defaultAction

ConversationContentCardAction defaultAction

description

String description

image

String image

title

String title

video

String video

Class com.mypurecloud.sdk.v2.model.ConversationContentCardAction

class ConversationContentCardAction extends Object implements Serializable

Serialized Fields

payload

String payload

text

String text

type

ConversationContentCardAction.TypeEnum type

url

String url

Class com.mypurecloud.sdk.v2.model.ConversationContentCarousel

class ConversationContentCarousel extends Object implements Serializable

Serialized Fields

cards

List<ConversationContentCard> cards

Class com.mypurecloud.sdk.v2.model.ConversationContentLocation

class ConversationContentLocation extends Object implements Serializable

Serialized Fields

address

String address

latitude

Double latitude

longitude

Double longitude

text

String text

url

String url

Class com.mypurecloud.sdk.v2.model.ConversationContentNotificationTemplate

class ConversationContentNotificationTemplate extends Object implements Serializable

Serialized Fields

body

ConversationNotificationTemplateBody body

footer

ConversationNotificationTemplateFooter footer

header

ConversationNotificationTemplateHeader header

id

String id

language

String language

Class com.mypurecloud.sdk.v2.model.ConversationContentQuickReply

class ConversationContentQuickReply extends Object implements Serializable

Serialized Fields

action

ConversationContentQuickReply.ActionEnum action

image

String image

payload

String payload

text

String text

Class com.mypurecloud.sdk.v2.model.ConversationContentQuickReplyV2

class ConversationContentQuickReplyV2 extends Object implements Serializable

Serialized Fields

actions

List<ConversationContentQuickReply> actions

title

String title

Class com.mypurecloud.sdk.v2.model.ConversationContentStory

class ConversationContentStory extends Object implements Serializable

Serialized Fields

replyToId

String replyToId

type

ConversationContentStory.TypeEnum type

url

String url

Class com.mypurecloud.sdk.v2.model.ConversationContentText

class ConversationContentText extends Object implements Serializable

Serialized Fields

body

String body

type

ConversationContentText.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ConversationDeletionProtectionQuery

class ConversationDeletionProtectionQuery extends Object implements Serializable

Serialized Fields

conversationIds

List<String> conversationIds

Class com.mypurecloud.sdk.v2.model.ConversationDetailQueryClause

class ConversationDetailQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<ConversationDetailQueryPredicate> predicates

type

ConversationDetailQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ConversationDetailQueryFilter

class ConversationDetailQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<ConversationDetailQueryClause> clauses

predicates

List<ConversationDetailQueryPredicate> predicates

type

ConversationDetailQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ConversationDetailQueryPredicate

class ConversationDetailQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

ConversationDetailQueryPredicate.DimensionEnum dimension

metric

ConversationDetailQueryPredicate.MetricEnum metric

operator

ConversationDetailQueryPredicate.OperatorEnum operator

range

NumericRange range

type

ConversationDetailQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.ConversationDetailsDatalakeAvailabilityTopicDataAvailabilityChangeNotification

class ConversationDetailsDatalakeAvailabilityTopicDataAvailabilityChangeNotification extends Object implements Serializable

Serialized Fields

dataAvailabilityDate

Date dataAvailabilityDate

Class com.mypurecloud.sdk.v2.model.ConversationDisconnectSettings

class ConversationDisconnectSettings extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

type

ConversationDisconnectSettings.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ConversationDivisionMembership

class ConversationDivisionMembership extends Object implements Serializable

Serialized Fields

division

DomainEntityRef division

entities

List<DomainEntityRef> entities

Class com.mypurecloud.sdk.v2.model.ConversationEmailEventTopicAttachment

class ConversationEmailEventTopicAttachment extends Object implements Serializable

Serialized Fields

attachmentId

String attachmentId

contentLength

Integer contentLength

contentType

String contentType

contentUri

String contentUri

name

String name

Class com.mypurecloud.sdk.v2.model.ConversationEmailEventTopicConversationRoutingData

class ConversationEmailEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

ConversationEmailEventTopicUriReference language

priority

Integer priority

queue

ConversationEmailEventTopicUriReference queue

scoredAgents

List<ConversationEmailEventTopicScoredAgent> scoredAgents

skills

List<ConversationEmailEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.ConversationEmailEventTopicDetail

class ConversationEmailEventTopicDetail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.ConversationEmailEventTopicEmailConversation

class ConversationEmailEventTopicEmailConversation extends Object implements Serializable

Serialized Fields

id

String id

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<ConversationEmailEventTopicEmailMediaParticipant> participants

Class com.mypurecloud.sdk.v2.model.ConversationEmailEventTopicEmailMediaParticipant

class ConversationEmailEventTopicEmailMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

autoGenerated

Boolean autoGenerated

connectedTime

Date connectedTime

conversationRoutingData

ConversationEmailEventTopicConversationRoutingData conversationRoutingData

direction

ConversationEmailEventTopicEmailMediaParticipant.DirectionEnum direction

disconnectType

ConversationEmailEventTopicEmailMediaParticipant.DisconnectTypeEnum disconnectType

draftAttachments

List<ConversationEmailEventTopicAttachment> draftAttachments

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

ConversationEmailEventTopicErrorBody errorInfo

externalContact

ConversationEmailEventTopicUriReference externalContact

externalOrganization

ConversationEmailEventTopicUriReference externalOrganization

flaggedReason

ConversationEmailEventTopicEmailMediaParticipant.FlaggedReasonEnum flaggedReason

held

Boolean held

id

String id

initialState

ConversationEmailEventTopicEmailMediaParticipant.InitialStateEnum initialState

journeyContext

ConversationEmailEventTopicJourneyContext journeyContext

mediaRoles

List<String> mediaRoles

messageId

String messageId

messagesSent

Integer messagesSent

name

String name

peer

String peer

provider

String provider

purpose

String purpose

queue

ConversationEmailEventTopicUriReference queue

screenRecordingState

String screenRecordingState

script

ConversationEmailEventTopicUriReference script

spam

Boolean spam

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

ConversationEmailEventTopicEmailMediaParticipant.StateEnum state

subject

String subject

team

ConversationEmailEventTopicUriReference team

user

ConversationEmailEventTopicUriReference user

wrapup

ConversationEmailEventTopicWrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.ConversationEmailEventTopicErrorBody

class ConversationEmailEventTopicErrorBody extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

details

List<ConversationEmailEventTopicDetail> details

entityId

String entityId

entityName

String entityName

errors

List<ConversationEmailEventTopicErrorBody> errors

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.ConversationEmailEventTopicJourneyAction

class ConversationEmailEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

ConversationEmailEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.ConversationEmailEventTopicJourneyActionMap

class ConversationEmailEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.ConversationEmailEventTopicJourneyContext

class ConversationEmailEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

ConversationEmailEventTopicJourneyCustomer customer

customerSession

ConversationEmailEventTopicJourneyCustomerSession customerSession

triggeringAction

ConversationEmailEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.ConversationEmailEventTopicJourneyCustomer

class ConversationEmailEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.ConversationEmailEventTopicJourneyCustomerSession

class ConversationEmailEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.ConversationEmailEventTopicScoredAgent

class ConversationEmailEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

ConversationEmailEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.ConversationEmailEventTopicUriReference

class ConversationEmailEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ConversationEmailEventTopicWrapup

class ConversationEmailEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.ConversationEncryptionConfiguration

class ConversationEncryptionConfiguration extends Object implements Serializable

Serialized Fields

id

String id

keyConfigurationType

ConversationEncryptionConfiguration.KeyConfigurationTypeEnum keyConfigurationType

lastError

ErrorBody lastError

selfUri

String selfUri

url

String url

Class com.mypurecloud.sdk.v2.model.ConversationEncryptionConfigurationListing

class ConversationEncryptionConfigurationListing extends Object implements Serializable

Serialized Fields

entities

List<ConversationEncryptionConfiguration> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ConversationEntityListing

class ConversationEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Conversation> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ConversationEventCoBrowse

class ConversationEventCoBrowse extends Object implements Serializable

Serialized Fields

sessionId

String sessionId

sessionJoinToken

String sessionJoinToken

type

ConversationEventCoBrowse.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ConversationEventPresence

class ConversationEventPresence extends Object implements Serializable

Serialized Fields

type

ConversationEventPresence.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicAddress

class ConversationEventTopicAddress extends Object implements Serializable

Serialized Fields

addressDisplayable

String addressDisplayable

addressNormalized

String addressNormalized

addressRaw

String addressRaw

name

String name

nameRaw

String nameRaw

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicAfterCallWork

class ConversationEventTopicAfterCallWork extends Object implements Serializable

Serialized Fields

endTime

Date endTime

startTime

Date startTime

state

ConversationEventTopicAfterCallWork.StateEnum state

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicAttachment

class ConversationEventTopicAttachment extends Object implements Serializable

Serialized Fields

attachmentId

String attachmentId

contentLength

Integer contentLength

contentType

String contentType

contentUri

String contentUri

name

String name

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicCall

class ConversationEventTopicCall extends Object implements Serializable

Serialized Fields

afterCallWork

ConversationEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

agentAssistantId

String agentAssistantId

bargedTime

Date bargedTime

confined

Boolean confined

connectedTime

Date connectedTime

direction

ConversationEventTopicCall.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectReasons

List<ConversationEventTopicDisconnectReason> disconnectReasons

disconnectType

ConversationEventTopicCall.DisconnectTypeEnum disconnectType

documentId

String documentId

errorInfo

ConversationEventTopicErrorDetails errorInfo

faxStatus

ConversationEventTopicFaxStatus faxStatus

held

Boolean held

id

String id

initialState

ConversationEventTopicCall.InitialStateEnum initialState

muted

Boolean muted

other

ConversationEventTopicAddress other

peerId

String peerId

provider

String provider

recording

Boolean recording

recordingState

ConversationEventTopicCall.RecordingStateEnum recordingState

scriptId

String scriptId

securePause

Boolean securePause

self

ConversationEventTopicAddress self

startHoldTime

Date startHoldTime

state

ConversationEventTopicCall.StateEnum state

uuiData

String uuiData

wrapup

ConversationEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicCallback

class ConversationEventTopicCallback extends Object implements Serializable

Serialized Fields

afterCallWork

ConversationEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

automatedCallbackConfigId

String automatedCallbackConfigId

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Date callbackScheduledTime

callbackUserName

String callbackUserName

callerId

String callerId

callerIdName

String callerIdName

connectedTime

Date connectedTime

dialerPreview

ConversationEventTopicDialerPreview dialerPreview

direction

ConversationEventTopicCallback.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectType

ConversationEventTopicCallback.DisconnectTypeEnum disconnectType

externalCampaign

Boolean externalCampaign

held

Boolean held

id

String id

initialState

ConversationEventTopicCallback.InitialStateEnum initialState

peerId

String peerId

provider

String provider

scriptId

String scriptId

skipEnabled

Boolean skipEnabled

startHoldTime

Date startHoldTime

state

ConversationEventTopicCallback.StateEnum state

timeoutSeconds

Integer timeoutSeconds

voicemail

ConversationEventTopicVoicemail voicemail

wrapup

ConversationEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicChat

class ConversationEventTopicChat extends Object implements Serializable

Serialized Fields

afterCallWork

ConversationEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

avatarImageUrl

String avatarImageUrl

connectedTime

Date connectedTime

disconnectedTime

Date disconnectedTime

disconnectType

ConversationEventTopicChat.DisconnectTypeEnum disconnectType

held

Boolean held

id

String id

initialState

ConversationEventTopicChat.InitialStateEnum initialState

journeyContext

ConversationEventTopicJourneyContext journeyContext

peerId

String peerId

provider

String provider

roomId

String roomId

scriptId

String scriptId

startHoldTime

Date startHoldTime

state

ConversationEventTopicChat.StateEnum state

wrapup

ConversationEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicCobrowse

class ConversationEventTopicCobrowse extends Object implements Serializable

Serialized Fields

afterCallWork

ConversationEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

cobrowseRole

String cobrowseRole

cobrowseSessionId

String cobrowseSessionId

connectedTime

Date connectedTime

controlling

List<String> controlling

disconnectedTime

Date disconnectedTime

disconnectType

ConversationEventTopicCobrowse.DisconnectTypeEnum disconnectType

id

String id

initialState

ConversationEventTopicCobrowse.InitialStateEnum initialState

peerId

String peerId

provider

String provider

providerEventTime

Date providerEventTime

roomId

String roomId

scriptId

String scriptId

self

ConversationEventTopicAddress self

state

ConversationEventTopicCobrowse.StateEnum state

viewerUrl

String viewerUrl

wrapup

ConversationEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicConversation

class ConversationEventTopicConversation extends Object implements Serializable

Serialized Fields

address

String address

externalTag

String externalTag

id

String id

maxParticipants

Integer maxParticipants

participants

List<ConversationEventTopicParticipant> participants

recentTransfers

List<ConversationEventTopicRecentTransfer> recentTransfers

recordingState

String recordingState

securePause

Boolean securePause

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicConversationRoutingData

class ConversationEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

ConversationEventTopicUriReference language

priority

Integer priority

queue

ConversationEventTopicUriReference queue

scoredAgents

List<ConversationEventTopicScoredAgent> scoredAgents

skills

List<ConversationEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicDestination

class ConversationEventTopicDestination extends Object implements Serializable

Serialized Fields

address

String address

userId

String userId

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicDialerPreview

class ConversationEventTopicDialerPreview extends Object implements Serializable

Serialized Fields

campaignId

String campaignId

contactId

String contactId

contactListId

String contactListId

id

String id

phoneNumberColumns

List<ConversationEventTopicPhoneNumberColumn> phoneNumberColumns

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicDisconnectReason

class ConversationEventTopicDisconnectReason extends Object implements Serializable

Serialized Fields

code

Integer code

phrase

String phrase

type

ConversationEventTopicDisconnectReason.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicEmail

class ConversationEventTopicEmail extends Object implements Serializable

Serialized Fields

afterCallWork

ConversationEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

autoGenerated

Boolean autoGenerated

connectedTime

Date connectedTime

direction

ConversationEventTopicEmail.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectType

ConversationEventTopicEmail.DisconnectTypeEnum disconnectType

draftAttachments

List<ConversationEventTopicAttachment> draftAttachments

errorInfo

ConversationEventTopicErrorDetails errorInfo

held

Boolean held

id

String id

initialState

ConversationEventTopicEmail.InitialStateEnum initialState

messageId

String messageId

messagesSent

Integer messagesSent

peerId

String peerId

provider

String provider

scriptId

String scriptId

spam

Boolean spam

startHoldTime

Date startHoldTime

state

ConversationEventTopicEmail.StateEnum state

subject

String subject

wrapup

ConversationEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicErrorDetails

class ConversationEventTopicErrorDetails extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

uri

String uri

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicFaxStatus

class ConversationEventTopicFaxStatus extends Object implements Serializable

Serialized Fields

activePage

Integer activePage

baudRate

Integer baudRate

bytesTransmitted

Integer bytesTransmitted

direction

String direction

expectedPages

Integer expectedPages

lineErrors

Integer lineErrors

linesTransmitted

Integer linesTransmitted

pageErrors

Integer pageErrors

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicInitiator

class ConversationEventTopicInitiator extends Object implements Serializable

Serialized Fields

userId

String userId

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicJourneyAction

class ConversationEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

ConversationEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicJourneyActionMap

class ConversationEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicJourneyContext

class ConversationEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

ConversationEventTopicJourneyCustomer customer

customerSession

ConversationEventTopicJourneyCustomerSession customerSession

triggeringAction

ConversationEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicJourneyCustomer

class ConversationEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicJourneyCustomerSession

class ConversationEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicMessage

class ConversationEventTopicMessage extends Object implements Serializable

Serialized Fields

afterCallWork

ConversationEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

agentAssistantId

String agentAssistantId

byoSmsIntegrationId

String byoSmsIntegrationId

connectedTime

Date connectedTime

direction

ConversationEventTopicMessage.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectType

ConversationEventTopicMessage.DisconnectTypeEnum disconnectType

errorInfo

ConversationEventTopicErrorDetails errorInfo

fromAddress

ConversationEventTopicAddress fromAddress

held

Boolean held

id

String id

initialState

ConversationEventTopicMessage.InitialStateEnum initialState

journeyContext

ConversationEventTopicJourneyContext journeyContext

messages

List<ConversationEventTopicMessageDetails> messages

messagesTranscriptUri

String messagesTranscriptUri

peerId

String peerId

provider

String provider

recipientCountry

String recipientCountry

recipientType

String recipientType

scriptId

String scriptId

startHoldTime

Date startHoldTime

state

ConversationEventTopicMessage.StateEnum state

toAddress

ConversationEventTopicAddress toAddress

type

ConversationEventTopicMessage.TypeEnum type

wrapup

ConversationEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicMessageDetails

class ConversationEventTopicMessageDetails extends Object implements Serializable

Serialized Fields

errorInfo

ConversationEventTopicErrorDetails errorInfo

media

List<ConversationEventTopicMessageMedia> media

messageId

String messageId

messageMetadata

ConversationEventTopicMessageMetadata messageMetadata

messageSegmentCount

Integer messageSegmentCount

messageStatus

ConversationEventTopicMessageDetails.MessageStatusEnum messageStatus

messageTime

Date messageTime

stickers

List<ConversationEventTopicMessageSticker> stickers

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicMessageMedia

class ConversationEventTopicMessageMedia extends Object implements Serializable

Serialized Fields

contentLengthBytes

Integer contentLengthBytes

id

String id

mediaType

String mediaType

name

String name

url

String url

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicMessageMetadata

class ConversationEventTopicMessageMetadata extends Object implements Serializable

Serialized Fields

content

List<ConversationEventTopicMessageMetadataContent> content

events

List<ConversationEventTopicMessageMetadataEvent> events

type

String type

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicMessageMetadataContent

class ConversationEventTopicMessageMetadataContent extends Object implements Serializable

Serialized Fields

contentType

String contentType

subType

String subType

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicMessageMetadataEvent

class ConversationEventTopicMessageMetadataEvent extends Object implements Serializable

Serialized Fields

eventType

String eventType

subType

String subType

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicMessageSticker

class ConversationEventTopicMessageSticker extends Object implements Serializable

Serialized Fields

id

String id

url

String url

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicModifiedBy

class ConversationEventTopicModifiedBy extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicObject

class ConversationEventTopicObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicParticipant

class ConversationEventTopicParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

bargedParticipantId

String bargedParticipantId

callbacks

List<ConversationEventTopicCallback> callbacks

calls

List<ConversationEventTopicCall> calls

chats

List<ConversationEventTopicChat> chats

coachedParticipantId

String coachedParticipantId

cobrowsesessions

List<ConversationEventTopicCobrowse> cobrowsesessions

connectedTime

Date connectedTime

consultParticipantId

String consultParticipantId

conversationRoutingData

ConversationEventTopicConversationRoutingData conversationRoutingData

emails

List<ConversationEventTopicEmail> emails

endAcwTime

Date endAcwTime

endTime

Date endTime

externalContactId

String externalContactId

externalOrganizationId

String externalOrganizationId

flaggedReason

String flaggedReason

groupId

String groupId

id

String id

mediaRoles

List<String> mediaRoles

messages

List<ConversationEventTopicMessage> messages

monitoredParticipantId

String monitoredParticipantId

name

String name

purpose

String purpose

queueId

String queueId

screenRecordingState

ConversationEventTopicParticipant.ScreenRecordingStateEnum screenRecordingState

screenshares

List<ConversationEventTopicScreenshare> screenshares

socialExpressions

List<ConversationEventTopicSocialExpression> socialExpressions

startAcwTime

Date startAcwTime

teamId

String teamId

userId

String userId

videos

List<ConversationEventTopicVideo> videos

workflow

ConversationEventTopicWorkflow workflow

wrapup

ConversationEventTopicWrapup wrapup

wrapupExpected

Boolean wrapupExpected

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicPhoneNumberColumn

class ConversationEventTopicPhoneNumberColumn extends Object implements Serializable

Serialized Fields

columnName

String columnName

type

String type

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicRecentTransfer

class ConversationEventTopicRecentTransfer extends Object implements Serializable

Serialized Fields

dateIssued

Date dateIssued

destination

ConversationEventTopicDestination destination

id

String id

initiator

ConversationEventTopicInitiator initiator

modifiedBy

ConversationEventTopicModifiedBy modifiedBy

state

ConversationEventTopicRecentTransfer.StateEnum state

transferType

ConversationEventTopicRecentTransfer.TransferTypeEnum transferType

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicScoredAgent

class ConversationEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

ConversationEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicScreenshare

class ConversationEventTopicScreenshare extends Object implements Serializable

Serialized Fields

afterCallWork

ConversationEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

connectedTime

Date connectedTime

context

String context

disconnectedTime

Date disconnectedTime

disconnectType

ConversationEventTopicScreenshare.DisconnectTypeEnum disconnectType

id

String id

initialState

ConversationEventTopicScreenshare.InitialStateEnum initialState

peerCount

Object peerCount

peerId

String peerId

provider

String provider

scriptId

String scriptId

self

ConversationEventTopicAddress self

sharing

Boolean sharing

state

ConversationEventTopicScreenshare.StateEnum state

wrapup

ConversationEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicSocialExpression

class ConversationEventTopicSocialExpression extends Object implements Serializable

Serialized Fields

afterCallWork

ConversationEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

connectedTime

Date connectedTime

disconnectedTime

Date disconnectedTime

disconnectType

ConversationEventTopicSocialExpression.DisconnectTypeEnum disconnectType

held

Boolean held

id

String id

initialState

ConversationEventTopicSocialExpression.InitialStateEnum initialState

peerId

String peerId

previewText

String previewText

provider

String provider

recordingId

String recordingId

scriptId

String scriptId

socialMediaHub

String socialMediaHub

socialMediaId

String socialMediaId

socialUserName

String socialUserName

startHoldTime

Date startHoldTime

state

ConversationEventTopicSocialExpression.StateEnum state

wrapup

ConversationEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicUriReference

class ConversationEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicVideo

class ConversationEventTopicVideo extends Object implements Serializable

Serialized Fields

afterCallWork

ConversationEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

audioMuted

Boolean audioMuted

connectedTime

Date connectedTime

context

String context

disconnectedTime

Date disconnectedTime

disconnectType

ConversationEventTopicVideo.DisconnectTypeEnum disconnectType

id

String id

initialState

ConversationEventTopicVideo.InitialStateEnum initialState

msids

List<String> msids

peerCount

Object peerCount

peerId

String peerId

provider

String provider

scriptId

String scriptId

self

ConversationEventTopicAddress self

sharingScreen

Boolean sharingScreen

state

ConversationEventTopicVideo.StateEnum state

videoMuted

Boolean videoMuted

wrapup

ConversationEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicVoicemail

class ConversationEventTopicVoicemail extends Object implements Serializable

Serialized Fields

id

String id

uploadStatus

ConversationEventTopicVoicemail.UploadStatusEnum uploadStatus

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicWorkflow

class ConversationEventTopicWorkflow extends Object implements Serializable

Serialized Fields

workflowId

String workflowId

Class com.mypurecloud.sdk.v2.model.ConversationEventTopicWrapup

class ConversationEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.ConversationEventTyping

class ConversationEventTyping extends Object implements Serializable

Serialized Fields

duration

Long duration

type

ConversationEventTyping.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ConversationMessageContent

class ConversationMessageContent extends Object implements Serializable

Serialized Fields

attachment

ConversationContentAttachment attachment

buttonResponse

ConversationContentButtonResponse buttonResponse

card

ConversationContentCard card

carousel

ConversationContentCarousel carousel

contentType

ConversationMessageContent.ContentTypeEnum contentType

location

ConversationContentLocation location

quickReply

ConversationContentQuickReply quickReply

quickReplyV2

ConversationContentQuickReplyV2 quickReplyV2

story

ConversationContentStory story

template

ConversationContentNotificationTemplate template

text

ConversationContentText text

Class com.mypurecloud.sdk.v2.model.ConversationMessageEvent

class ConversationMessageEvent extends Object implements Serializable

Serialized Fields

coBrowse

ConversationEventCoBrowse coBrowse

eventType

ConversationMessageEvent.EventTypeEnum eventType

presence

ConversationEventPresence presence

typing

ConversationEventTyping typing

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicConversationRoutingData

class ConversationMessageEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

ConversationMessageEventTopicUriReference language

priority

Integer priority

queue

ConversationMessageEventTopicUriReference queue

scoredAgents

List<ConversationMessageEventTopicScoredAgent> scoredAgents

skills

List<ConversationMessageEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicDetail

class ConversationMessageEventTopicDetail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicErrorBody

class ConversationMessageEventTopicErrorBody extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

details

List<ConversationMessageEventTopicDetail> details

entityId

String entityId

entityName

String entityName

errors

List<ConversationMessageEventTopicErrorBody> errors

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicErrorDetails

class ConversationMessageEventTopicErrorDetails extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

uri

String uri

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicJourneyAction

class ConversationMessageEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

ConversationMessageEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicJourneyActionMap

class ConversationMessageEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicJourneyContext

class ConversationMessageEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

ConversationMessageEventTopicJourneyCustomer customer

customerSession

ConversationMessageEventTopicJourneyCustomerSession customerSession

triggeringAction

ConversationMessageEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicJourneyCustomer

class ConversationMessageEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicJourneyCustomerSession

class ConversationMessageEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicMessageConversation

class ConversationMessageEventTopicMessageConversation extends Object implements Serializable

Serialized Fields

id

String id

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<ConversationMessageEventTopicMessageMediaParticipant> participants

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicMessageDetails

class ConversationMessageEventTopicMessageDetails extends Object implements Serializable

Serialized Fields

errorInfo

ConversationMessageEventTopicErrorDetails errorInfo

media

List<ConversationMessageEventTopicMessageMedia> media

message

ConversationMessageEventTopicUriReference message

messageMetadata

ConversationMessageEventTopicMessageMetadata messageMetadata

messageSegmentCount

Integer messageSegmentCount

messageStatus

ConversationMessageEventTopicMessageDetails.MessageStatusEnum messageStatus

messageTime

Date messageTime

stickers

List<ConversationMessageEventTopicMessageSticker> stickers

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicMessageMedia

class ConversationMessageEventTopicMessageMedia extends Object implements Serializable

Serialized Fields

contentLengthBytes

Integer contentLengthBytes

id

String id

mediaType

String mediaType

name

String name

url

String url

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicMessageMediaParticipant

class ConversationMessageEventTopicMessageMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

byoSmsIntegrationId

String byoSmsIntegrationId

connectedTime

Date connectedTime

conversationRoutingData

ConversationMessageEventTopicConversationRoutingData conversationRoutingData

direction

ConversationMessageEventTopicMessageMediaParticipant.DirectionEnum direction

disconnectType

ConversationMessageEventTopicMessageMediaParticipant.DisconnectTypeEnum disconnectType

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

ConversationMessageEventTopicErrorBody errorInfo

externalContact

ConversationMessageEventTopicUriReference externalContact

externalOrganization

ConversationMessageEventTopicUriReference externalOrganization

flaggedReason

ConversationMessageEventTopicMessageMediaParticipant.FlaggedReasonEnum flaggedReason

held

Boolean held

id

String id

initialState

ConversationMessageEventTopicMessageMediaParticipant.InitialStateEnum initialState

journeyContext

ConversationMessageEventTopicJourneyContext journeyContext

mediaRoles

List<String> mediaRoles

messages

List<ConversationMessageEventTopicMessageDetails> messages

monitoredParticipantId

String monitoredParticipantId

name

String name

peer

String peer

provider

String provider

purpose

String purpose

queue

ConversationMessageEventTopicUriReference queue

recipientCountry

String recipientCountry

recipientType

String recipientType

screenRecordingState

String screenRecordingState

script

ConversationMessageEventTopicUriReference script

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

ConversationMessageEventTopicMessageMediaParticipant.StateEnum state

team

ConversationMessageEventTopicUriReference team

type

ConversationMessageEventTopicMessageMediaParticipant.TypeEnum type

user

ConversationMessageEventTopicUriReference user

wrapup

ConversationMessageEventTopicWrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicMessageMetadata

class ConversationMessageEventTopicMessageMetadata extends Object implements Serializable

Serialized Fields

content

List<ConversationMessageEventTopicMessageMetadataContent> content

events

List<ConversationMessageEventTopicMessageMetadataEvent> events

type

String type

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicMessageMetadataContent

class ConversationMessageEventTopicMessageMetadataContent extends Object implements Serializable

Serialized Fields

contentType

String contentType

subType

String subType

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicMessageMetadataEvent

class ConversationMessageEventTopicMessageMetadataEvent extends Object implements Serializable

Serialized Fields

eventType

String eventType

subType

String subType

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicMessageSticker

class ConversationMessageEventTopicMessageSticker extends Object implements Serializable

Serialized Fields

id

String id

url

String url

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicScoredAgent

class ConversationMessageEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

ConversationMessageEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicUriReference

class ConversationMessageEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ConversationMessageEventTopicWrapup

class ConversationMessageEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.ConversationMessageMetadata

class ConversationMessageMetadata extends Object implements Serializable

Serialized Fields

content

List<ConversationMessageMetadataContent> content

events

List<ConversationMessageMetadataEvent> events

type

ConversationMessageMetadata.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ConversationMessageMetadataContent

class ConversationMessageMetadataContent extends Object implements Serializable

Serialized Fields

contentType

ConversationMessageMetadataContent.ContentTypeEnum contentType

subType

ConversationMessageMetadataContent.SubTypeEnum subType

Class com.mypurecloud.sdk.v2.model.ConversationMessageMetadataEvent

class ConversationMessageMetadataEvent extends Object implements Serializable

Serialized Fields

eventType

ConversationMessageMetadataEvent.EventTypeEnum eventType

subType

ConversationMessageMetadataEvent.SubTypeEnum subType

Class com.mypurecloud.sdk.v2.model.ConversationMessagingChannel

class ConversationMessagingChannel extends Object implements Serializable

Serialized Fields

dateDeleted

Date dateDeleted

dateModified

Date dateModified

from

ConversationMessagingFromRecipient from

id

String id

messageId

String messageId

platform

ConversationMessagingChannel.PlatformEnum platform

time

Date time

to

ConversationMessagingToRecipient to

Class com.mypurecloud.sdk.v2.model.ConversationMessagingFromRecipient

class ConversationMessagingFromRecipient extends Object implements Serializable

Serialized Fields

additionalIds

List<ConversationRecipientAdditionalIdentifier> additionalIds

email

String email

firstName

String firstName

id

String id

idType

ConversationMessagingFromRecipient.IdTypeEnum idType

image

String image

lastName

String lastName

nickname

String nickname

Class com.mypurecloud.sdk.v2.model.ConversationMessagingToRecipient

class ConversationMessagingToRecipient extends Object implements Serializable

Serialized Fields

additionalIds

List<ConversationRecipientAdditionalIdentifier> additionalIds

email

String email

firstName

String firstName

id

String id

idType

ConversationMessagingToRecipient.IdTypeEnum idType

image

String image

lastName

String lastName

nickname

String nickname

Class com.mypurecloud.sdk.v2.model.ConversationMetrics

class ConversationMetrics extends Object implements Serializable

Serialized Fields

conversation

AddressableEntityRef conversation

participantMetrics

ParticipantMetrics participantMetrics

sentimentScore

Double sentimentScore

sentimentTrend

Double sentimentTrend

sentimentTrendClass

ConversationMetrics.SentimentTrendClassEnum sentimentTrendClass

Class com.mypurecloud.sdk.v2.model.ConversationMetricsTopicConversationMetricRecord

class ConversationMetricsTopicConversationMetricRecord extends Object implements Serializable

Serialized Fields

activeSkillIds

List<String> activeSkillIds

addressFrom

String addressFrom

addressTo

String addressTo

agentAssistantId

String agentAssistantId

agentBullseyeRing

Integer agentBullseyeRing

agentOwned

Boolean agentOwned

ani

String ani

assignerId

String assignerId

authenticated

Boolean authenticated

conversationId

String conversationId

conversationInitiator

ConversationMetricsTopicConversationMetricRecord.ConversationInitiatorEnum conversationInitiator

convertedFrom

String convertedFrom

convertedTo

String convertedTo

customerParticipation

Boolean customerParticipation

deliveryStatus

ConversationMetricsTopicConversationMetricRecord.DeliveryStatusEnum deliveryStatus

destinationAddresses

List<String> destinationAddresses

direction

ConversationMetricsTopicConversationMetricRecord.DirectionEnum direction

disconnectType

ConversationMetricsTopicConversationMetricRecord.DisconnectTypeEnum disconnectType

divisionIds

List<String> divisionIds

dnis

String dnis

edgeId

String edgeId

eligibleAgentCounts

List<Integer> eligibleAgentCounts

errorCode

String errorCode

extendedDeliveryStatus

String extendedDeliveryStatus

externalContactId

String externalContactId

externalMediaCount

Integer externalMediaCount

externalOrganizationId

String externalOrganizationId

externalTag

String externalTag

firstQueue

Boolean firstQueue

flaggedReason

ConversationMetricsTopicConversationMetricRecord.FlaggedReasonEnum flaggedReason

flowInType

String flowInType

flowOutType

String flowOutType

groupId

String groupId

interactionType

String interactionType

journeyActionId

String journeyActionId

journeyActionMapId

String journeyActionMapId

journeyActionMapVersion

Integer journeyActionMapVersion

journeyCustomerId

String journeyCustomerId

journeyCustomerIdType

String journeyCustomerIdType

journeyCustomerSessionId

String journeyCustomerSessionId

journeyCustomerSessionIdType

String journeyCustomerSessionIdType

knowledgeBaseIds

List<String> knowledgeBaseIds

mediaCount

Integer mediaCount

mediaType

ConversationMetricsTopicConversationMetricRecord.MediaTypeEnum mediaType

messageType

String messageType

metric

ConversationMetricsTopicConversationMetricRecord.MetricEnum metric

metricDate

Date metricDate

originatingDirection

ConversationMetricsTopicConversationMetricRecord.OriginatingDirectionEnum originatingDirection

outboundCampaignId

String outboundCampaignId

outboundContactId

String outboundContactId

outboundContactListId

String outboundContactListId

participantName

String participantName

peerId

String peerId

proposedAgents

List<ConversationMetricsTopicConversationProposedAgent> proposedAgents

provider

String provider

purpose

ConversationMetricsTopicConversationMetricRecord.PurposeEnum purpose

queueId

String queueId

recordId

String recordId

remote

String remote

removedSkillIds

List<String> removedSkillIds

reoffered

Boolean reoffered

requestedLanguageId

String requestedLanguageId

requestedRoutings

List<ConversationMetricsTopicConversationMetricRecord.RequestedRoutingsEnum> requestedRoutings

requestedRoutingSkillIds

List<String> requestedRoutingSkillIds

roomId

String roomId

routingPriority

Integer routingPriority

routingRing

Integer routingRing

scoredAgents

List<ConversationMetricsTopicConversationScoredAgent> scoredAgents

selectedAgentId

String selectedAgentId

selectedAgentRank

Integer selectedAgentRank

selfServed

Boolean selfServed

sessionDnis

String sessionDnis

sessionId

String sessionId

stationId

String stationId

teamId

String teamId

usedRouting

ConversationMetricsTopicConversationMetricRecord.UsedRoutingEnum usedRouting

userId

String userId

value

Integer value

waitingInteractionCounts

List<Integer> waitingInteractionCounts

wrapUpCode

String wrapUpCode

Class com.mypurecloud.sdk.v2.model.ConversationMetricsTopicConversationProposedAgent

class ConversationMetricsTopicConversationProposedAgent extends Object implements Serializable

Serialized Fields

agentRank

Integer agentRank

proposedAgentId

String proposedAgentId

Class com.mypurecloud.sdk.v2.model.ConversationMetricsTopicConversationScoredAgent

class ConversationMetricsTopicConversationScoredAgent extends Object implements Serializable

Serialized Fields

agentScore

Integer agentScore

scoredAgentId

String scoredAgentId

Class com.mypurecloud.sdk.v2.model.ConversationNormalizedMessage

class ConversationNormalizedMessage extends Object implements Serializable

Serialized Fields

byoSmsIntegrationId

String byoSmsIntegrationId

channel

ConversationMessagingChannel channel

content

List<ConversationMessageContent> content

direction

ConversationNormalizedMessage.DirectionEnum direction

events

List<ConversationMessageEvent> events

id

String id

isFinalReceipt

Boolean isFinalReceipt

metadata

Map<String,String> metadata

originatingEntity

ConversationNormalizedMessage.OriginatingEntityEnum originatingEntity

reasons

List<ConversationReason> reasons

status

ConversationNormalizedMessage.StatusEnum status

text

String text

type

ConversationNormalizedMessage.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ConversationNotificationTemplateBody

class ConversationNotificationTemplateBody extends Object implements Serializable

Serialized Fields

parameters

List<ConversationNotificationTemplateParameter> parameters

text

String text

Class com.mypurecloud.sdk.v2.model.ConversationNotificationTemplateFooter

class ConversationNotificationTemplateFooter extends Object implements Serializable

Serialized Fields

text

String text

Class com.mypurecloud.sdk.v2.model.ConversationNotificationTemplateHeader

class ConversationNotificationTemplateHeader extends Object implements Serializable

Serialized Fields

media

ConversationContentAttachment media

parameters

List<ConversationNotificationTemplateParameter> parameters

text

String text

type

ConversationNotificationTemplateHeader.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ConversationNotificationTemplateParameter

class ConversationNotificationTemplateParameter extends Object implements Serializable

Serialized Fields

name

String name

text

String text

Class com.mypurecloud.sdk.v2.model.ConversationParticipantSearchCriteria

class ConversationParticipantSearchCriteria extends Object implements Serializable

Serialized Fields

dateFormat

String dateFormat

endValue

String endValue

fields

List<String> fields

group

List<ConversationParticipantSearchCriteria> group

operator

ConversationParticipantSearchCriteria.OperatorEnum operator

startValue

String startValue

type

ConversationParticipantSearchCriteria.TypeEnum type

value

String value

values

List<String> values

Class com.mypurecloud.sdk.v2.model.ConversationParticipantSearchRequest

class ConversationParticipantSearchRequest extends Object implements Serializable

Serialized Fields

cursor

String cursor

query

List<ConversationParticipantSearchCriteria> query

returnFields

List<String> returnFields

sort

List<SearchSort> sort

sortBy

String sortBy

sortOrder

ConversationParticipantSearchRequest.SortOrderEnum sortOrder

Class com.mypurecloud.sdk.v2.model.ConversationProperties

class ConversationProperties extends Object implements Serializable

Serialized Fields

filterWrapUpNotes

Boolean filterWrapUpNotes

isAcd

Boolean isAcd

isActive

Boolean isActive

isCobrowse

Boolean isCobrowse

isFlagged

Boolean isFlagged

isMonitored

Boolean isMonitored

isPreferred

Boolean isPreferred

isScreenshare

Boolean isScreenshare

isVoicemail

Boolean isVoicemail

isWaiting

Boolean isWaiting

matchAll

Boolean matchAll

Class com.mypurecloud.sdk.v2.model.ConversationQuery

class ConversationQuery extends Object implements Serializable

Serialized Fields

aggregations

List<AnalyticsQueryAggregation> aggregations

conversationFilters

List<ConversationDetailQueryFilter> conversationFilters

evaluationFilters

List<EvaluationDetailQueryFilter> evaluationFilters

interval

String interval

order

ConversationQuery.OrderEnum order

orderBy

ConversationQuery.OrderByEnum orderBy

paging

PagingSpec paging

resolutionFilters

List<ResolutionDetailQueryFilter> resolutionFilters

segmentFilters

List<SegmentDetailQueryFilter> segmentFilters

surveyFilters

List<SurveyDetailQueryFilter> surveyFilters

Class com.mypurecloud.sdk.v2.model.ConversationReason

class ConversationReason extends Object implements Serializable

Serialized Fields

code

ConversationReason.CodeEnum code

message

String message

Class com.mypurecloud.sdk.v2.model.ConversationRecipientAdditionalIdentifier

class ConversationRecipientAdditionalIdentifier extends Object implements Serializable

Serialized Fields

type

ConversationRecipientAdditionalIdentifier.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.ConversationReference

class ConversationReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ConversationRoutingData

class ConversationRoutingData extends Object implements Serializable

Serialized Fields

language

AddressableEntityRef language

priority

Integer priority

queue

AddressableEntityRef queue

scoredAgents

List<ScoredAgent> scoredAgents

skills

List<AddressableEntityRef> skills

Class com.mypurecloud.sdk.v2.model.ConversationScreenShareEventTopicConversationRoutingData

class ConversationScreenShareEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

ConversationScreenShareEventTopicUriReference language

priority

Integer priority

queue

ConversationScreenShareEventTopicUriReference queue

scoredAgents

List<ConversationScreenShareEventTopicScoredAgent> scoredAgents

skills

List<ConversationScreenShareEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.ConversationScreenShareEventTopicDetail

class ConversationScreenShareEventTopicDetail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.ConversationScreenShareEventTopicErrorBody

class ConversationScreenShareEventTopicErrorBody extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

details

List<ConversationScreenShareEventTopicDetail> details

entityId

String entityId

entityName

String entityName

errors

List<ConversationScreenShareEventTopicErrorBody> errors

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.ConversationScreenShareEventTopicJourneyAction

class ConversationScreenShareEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

ConversationScreenShareEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.ConversationScreenShareEventTopicJourneyActionMap

class ConversationScreenShareEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.ConversationScreenShareEventTopicJourneyContext

class ConversationScreenShareEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

ConversationScreenShareEventTopicJourneyCustomer customer

customerSession

ConversationScreenShareEventTopicJourneyCustomerSession customerSession

triggeringAction

ConversationScreenShareEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.ConversationScreenShareEventTopicJourneyCustomer

class ConversationScreenShareEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.ConversationScreenShareEventTopicJourneyCustomerSession

class ConversationScreenShareEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.ConversationScreenShareEventTopicScoredAgent

class ConversationScreenShareEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

ConversationScreenShareEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.ConversationScreenShareEventTopicScreenShareConversation

class ConversationScreenShareEventTopicScreenShareConversation extends Object implements Serializable

Serialized Fields

id

String id

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<ConversationScreenShareEventTopicScreenShareMediaParticipant> participants

Class com.mypurecloud.sdk.v2.model.ConversationScreenShareEventTopicScreenShareMediaParticipant

class ConversationScreenShareEventTopicScreenShareMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

connectedTime

Date connectedTime

context

String context

conversationRoutingData

ConversationScreenShareEventTopicConversationRoutingData conversationRoutingData

direction

ConversationScreenShareEventTopicScreenShareMediaParticipant.DirectionEnum direction

disconnectType

ConversationScreenShareEventTopicScreenShareMediaParticipant.DisconnectTypeEnum disconnectType

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

ConversationScreenShareEventTopicErrorBody errorInfo

externalContact

ConversationScreenShareEventTopicUriReference externalContact

externalOrganization

ConversationScreenShareEventTopicUriReference externalOrganization

flaggedReason

ConversationScreenShareEventTopicScreenShareMediaParticipant.FlaggedReasonEnum flaggedReason

held

Boolean held

id

String id

initialState

ConversationScreenShareEventTopicScreenShareMediaParticipant.InitialStateEnum initialState

journeyContext

ConversationScreenShareEventTopicJourneyContext journeyContext

mediaRoles

List<String> mediaRoles

name

String name

peer

String peer

peerCount

Integer peerCount

provider

String provider

purpose

String purpose

queue

ConversationScreenShareEventTopicUriReference queue

screenRecordingState

String screenRecordingState

script

ConversationScreenShareEventTopicUriReference script

sharing

Boolean sharing

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

ConversationScreenShareEventTopicScreenShareMediaParticipant.StateEnum state

team

ConversationScreenShareEventTopicUriReference team

user

ConversationScreenShareEventTopicUriReference user

wrapup

ConversationScreenShareEventTopicWrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.ConversationScreenShareEventTopicUriReference

class ConversationScreenShareEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ConversationScreenShareEventTopicWrapup

class ConversationScreenShareEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.ConversationSecureAttributes

class ConversationSecureAttributes extends Object implements Serializable

Serialized Fields

attributes

Map<String,String> attributes

version

Integer version

Class com.mypurecloud.sdk.v2.model.ConversationSocialExpressionEventTopicConversationRoutingData

class ConversationSocialExpressionEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

ConversationSocialExpressionEventTopicUriReference language

priority

Integer priority

queue

ConversationSocialExpressionEventTopicUriReference queue

scoredAgents

List<ConversationSocialExpressionEventTopicScoredAgent> scoredAgents

skills

List<ConversationSocialExpressionEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.ConversationSocialExpressionEventTopicDetail

class ConversationSocialExpressionEventTopicDetail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.ConversationSocialExpressionEventTopicErrorBody

class ConversationSocialExpressionEventTopicErrorBody extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

details

List<ConversationSocialExpressionEventTopicDetail> details

entityId

String entityId

entityName

String entityName

errors

List<ConversationSocialExpressionEventTopicErrorBody> errors

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.ConversationSocialExpressionEventTopicJourneyAction

class ConversationSocialExpressionEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

ConversationSocialExpressionEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.ConversationSocialExpressionEventTopicJourneyActionMap

class ConversationSocialExpressionEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.ConversationSocialExpressionEventTopicJourneyContext

class ConversationSocialExpressionEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

ConversationSocialExpressionEventTopicJourneyCustomer customer

customerSession

ConversationSocialExpressionEventTopicJourneyCustomerSession customerSession

triggeringAction

ConversationSocialExpressionEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.ConversationSocialExpressionEventTopicJourneyCustomer

class ConversationSocialExpressionEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.ConversationSocialExpressionEventTopicJourneyCustomerSession

class ConversationSocialExpressionEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.ConversationSocialExpressionEventTopicScoredAgent

class ConversationSocialExpressionEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

ConversationSocialExpressionEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.ConversationSocialExpressionEventTopicSocialConversation

class ConversationSocialExpressionEventTopicSocialConversation extends Object implements Serializable

Serialized Fields

id

String id

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<ConversationSocialExpressionEventTopicSocialMediaParticipant> participants

Class com.mypurecloud.sdk.v2.model.ConversationSocialExpressionEventTopicSocialMediaParticipant

class ConversationSocialExpressionEventTopicSocialMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

connectedTime

Date connectedTime

conversationRoutingData

ConversationSocialExpressionEventTopicConversationRoutingData conversationRoutingData

direction

ConversationSocialExpressionEventTopicSocialMediaParticipant.DirectionEnum direction

disconnectType

ConversationSocialExpressionEventTopicSocialMediaParticipant.DisconnectTypeEnum disconnectType

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

ConversationSocialExpressionEventTopicErrorBody errorInfo

externalContact

ConversationSocialExpressionEventTopicUriReference externalContact

externalOrganization

ConversationSocialExpressionEventTopicUriReference externalOrganization

flaggedReason

ConversationSocialExpressionEventTopicSocialMediaParticipant.FlaggedReasonEnum flaggedReason

held

Boolean held

id

String id

initialState

ConversationSocialExpressionEventTopicSocialMediaParticipant.InitialStateEnum initialState

journeyContext

ConversationSocialExpressionEventTopicJourneyContext journeyContext

mediaRoles

List<String> mediaRoles

name

String name

peer

String peer

previewText

String previewText

provider

String provider

purpose

String purpose

queue

ConversationSocialExpressionEventTopicUriReference queue

screenRecordingState

String screenRecordingState

script

ConversationSocialExpressionEventTopicUriReference script

socialMediaHub

String socialMediaHub

socialMediaId

String socialMediaId

socialUserName

String socialUserName

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

ConversationSocialExpressionEventTopicSocialMediaParticipant.StateEnum state

team

ConversationSocialExpressionEventTopicUriReference team

user

ConversationSocialExpressionEventTopicUriReference user

wrapup

ConversationSocialExpressionEventTopicWrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.ConversationSocialExpressionEventTopicUriReference

class ConversationSocialExpressionEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ConversationSocialExpressionEventTopicWrapup

class ConversationSocialExpressionEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.ConversationTagsUpdate

class ConversationTagsUpdate extends Object implements Serializable

Serialized Fields

externalTag

String externalTag

Class com.mypurecloud.sdk.v2.model.ConversationThreadingWindow

class ConversationThreadingWindow extends Object implements Serializable

Serialized Fields

defaultTimeoutMinutes

Long defaultTimeoutMinutes

id

String id

settings

List<ConversationThreadingWindowSetting> settings

Class com.mypurecloud.sdk.v2.model.ConversationThreadingWindowSetting

class ConversationThreadingWindowSetting extends Object implements Serializable

Serialized Fields

messengerType

ConversationThreadingWindowSetting.MessengerTypeEnum messengerType

timeoutInMinutes

Long timeoutInMinutes

Class com.mypurecloud.sdk.v2.model.ConversationUser

class ConversationUser extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.ConversationUserDisposition

class ConversationUserDisposition extends Object implements Serializable

Serialized Fields

code

String code

notes

String notes

user

AddressableEntityRef user

Class com.mypurecloud.sdk.v2.model.ConversationVideoEventTopicConversationRoutingData

class ConversationVideoEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

ConversationVideoEventTopicUriReference language

priority

Integer priority

queue

ConversationVideoEventTopicUriReference queue

scoredAgents

List<ConversationVideoEventTopicScoredAgent> scoredAgents

skills

List<ConversationVideoEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.ConversationVideoEventTopicDetail

class ConversationVideoEventTopicDetail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.ConversationVideoEventTopicErrorBody

class ConversationVideoEventTopicErrorBody extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

details

List<ConversationVideoEventTopicDetail> details

entityId

String entityId

entityName

String entityName

errors

List<ConversationVideoEventTopicErrorBody> errors

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.ConversationVideoEventTopicJourneyAction

class ConversationVideoEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

ConversationVideoEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.ConversationVideoEventTopicJourneyActionMap

class ConversationVideoEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.ConversationVideoEventTopicJourneyContext

class ConversationVideoEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

ConversationVideoEventTopicJourneyCustomer customer

customerSession

ConversationVideoEventTopicJourneyCustomerSession customerSession

triggeringAction

ConversationVideoEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.ConversationVideoEventTopicJourneyCustomer

class ConversationVideoEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.ConversationVideoEventTopicJourneyCustomerSession

class ConversationVideoEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.ConversationVideoEventTopicScoredAgent

class ConversationVideoEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

ConversationVideoEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.ConversationVideoEventTopicUriReference

class ConversationVideoEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.ConversationVideoEventTopicVideoConversation

class ConversationVideoEventTopicVideoConversation extends Object implements Serializable

Serialized Fields

id

String id

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<ConversationVideoEventTopicVideoMediaParticipant> participants

Class com.mypurecloud.sdk.v2.model.ConversationVideoEventTopicVideoMediaParticipant

class ConversationVideoEventTopicVideoMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

audioMuted

Boolean audioMuted

connectedTime

Date connectedTime

context

String context

conversationRoutingData

ConversationVideoEventTopicConversationRoutingData conversationRoutingData

direction

ConversationVideoEventTopicVideoMediaParticipant.DirectionEnum direction

disconnectType

ConversationVideoEventTopicVideoMediaParticipant.DisconnectTypeEnum disconnectType

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

ConversationVideoEventTopicErrorBody errorInfo

externalContact

ConversationVideoEventTopicUriReference externalContact

externalOrganization

ConversationVideoEventTopicUriReference externalOrganization

flaggedReason

ConversationVideoEventTopicVideoMediaParticipant.FlaggedReasonEnum flaggedReason

held

Boolean held

id

String id

initialState

ConversationVideoEventTopicVideoMediaParticipant.InitialStateEnum initialState

journeyContext

ConversationVideoEventTopicJourneyContext journeyContext

mediaRoles

List<String> mediaRoles

msids

List<String> msids

name

String name

peer

String peer

peerCount

Integer peerCount

provider

String provider

purpose

String purpose

queue

ConversationVideoEventTopicUriReference queue

screenRecordingState

String screenRecordingState

script

ConversationVideoEventTopicUriReference script

sharingScreen

Boolean sharingScreen

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

ConversationVideoEventTopicVideoMediaParticipant.StateEnum state

team

ConversationVideoEventTopicUriReference team

user

ConversationVideoEventTopicUriReference user

videoMuted

Boolean videoMuted

wrapup

ConversationVideoEventTopicWrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.ConversationVideoEventTopicWrapup

class ConversationVideoEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.CopyAttachmentsRequest

class CopyAttachmentsRequest extends Object implements Serializable

Serialized Fields

attachments

List<Attachment> attachments

sourceMessage

DomainEntityRef sourceMessage

Class com.mypurecloud.sdk.v2.model.CopyBuForecastRequest

class CopyBuForecastRequest extends Object implements Serializable

Serialized Fields

description

String description

weekDate

LocalDate weekDate

Class com.mypurecloud.sdk.v2.model.CopyVoicemailMessage

class CopyVoicemailMessage extends Object implements Serializable

Serialized Fields

groupId

String groupId

userId

String userId

voicemailMessageId

String voicemailMessageId

Class com.mypurecloud.sdk.v2.model.CopyWorkPlan

class CopyWorkPlan extends Object implements Serializable

Serialized Fields

name

String name

Class com.mypurecloud.sdk.v2.model.CopyWorkPlanRotationRequest

class CopyWorkPlanRotationRequest extends Object implements Serializable

Serialized Fields

name

String name

Class com.mypurecloud.sdk.v2.model.Coretype

class Coretype extends Object implements Serializable

Serialized Fields

current

Boolean current

dateCreated

Date dateCreated

id

String id

itemValidationFields

List<String> itemValidationFields

itemValidationLimits

ItemValidationLimits itemValidationLimits

name

String name

schema

Schema schema

selfUri

String selfUri

validationFields

List<String> validationFields

validationLimits

ValidationLimits validationLimits

version

Integer version

Class com.mypurecloud.sdk.v2.model.CoretypeListing

class CoretypeListing extends Object implements Serializable

Serialized Fields

entities

List<Coretype> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.CoverSheet

class CoverSheet extends Object implements Serializable

Serialized Fields

locale

String locale

notes

String notes

Class com.mypurecloud.sdk.v2.model.CreateActivityCodeRequest

class CreateActivityCodeRequest extends Object implements Serializable

Serialized Fields

agentTimeOffSelectable

Boolean agentTimeOffSelectable

category

CreateActivityCodeRequest.CategoryEnum category

countsAsPaidTime

Boolean countsAsPaidTime

countsAsWorkTime

Boolean countsAsWorkTime

countsTowardShrinkage

Boolean countsTowardShrinkage

interruptible

Boolean interruptible

lengthInMinutes

Integer lengthInMinutes

name

String name

plannedShrinkage

Boolean plannedShrinkage

secondaryPresences

List<SecondaryPresence> secondaryPresences

Class com.mypurecloud.sdk.v2.model.CreateAdminTimeOffRequest

class CreateAdminTimeOffRequest extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

dailyDurationMinutes

Integer dailyDurationMinutes

fullDayManagementUnitDates

List<String> fullDayManagementUnitDates

notes

String notes

paid

Boolean paid

partialDayStartDateTimes

List<Date> partialDayStartDateTimes

status

CreateAdminTimeOffRequest.StatusEnum status

users

List<UserReference> users

Class com.mypurecloud.sdk.v2.model.CreateAgentTimeOffRequest

class CreateAgentTimeOffRequest extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

dailyDurationMinutes

Integer dailyDurationMinutes

fullDayManagementUnitDates

List<String> fullDayManagementUnitDates

notes

String notes

partialDayStartDateTimes

List<Date> partialDayStartDateTimes

Class com.mypurecloud.sdk.v2.model.CreateBenefitAssessmentJobRequest

class CreateBenefitAssessmentJobRequest extends Object implements Serializable

Serialized Fields

divisionIds

List<String> divisionIds

Class com.mypurecloud.sdk.v2.model.CreateBenefitAssessmentRequest

class CreateBenefitAssessmentRequest extends Object implements Serializable

Serialized Fields

queueIds

List<String> queueIds

Class com.mypurecloud.sdk.v2.model.CreateBusinessUnitRequest

class CreateBusinessUnitRequest extends Object implements Serializable

Serialized Fields

divisionId

String divisionId

name

String name

settings

CreateBusinessUnitSettingsRequest settings

Class com.mypurecloud.sdk.v2.model.CreateBusinessUnitSettingsRequest

class CreateBusinessUnitSettingsRequest extends Object implements Serializable

Serialized Fields

scheduling

BuSchedulingSettingsRequest scheduling

shortTermForecasting

BuShortTermForecastingSettings shortTermForecasting

startDayOfWeek

CreateBusinessUnitSettingsRequest.StartDayOfWeekEnum startDayOfWeek

timeZone

String timeZone

Class com.mypurecloud.sdk.v2.model.CreateCallbackCommand

class CreateCallbackCommand extends Object implements Serializable

Serialized Fields

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Date callbackScheduledTime

callbackUserName

String callbackUserName

callerId

String callerId

callerIdName

String callerIdName

countryCode

String countryCode

data

Map<String,String> data

queueId

String queueId

routingData

RoutingData routingData

scriptId

String scriptId

validateCallbackNumbers

Boolean validateCallbackNumbers

Class com.mypurecloud.sdk.v2.model.CreateCallbackOnConversationCommand

class CreateCallbackOnConversationCommand extends Object implements Serializable

Serialized Fields

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Date callbackScheduledTime

callbackUserName

String callbackUserName

callerId

String callerId

callerIdName

String callerIdName

countryCode

String countryCode

data

Map<String,String> data

queueId

String queueId

routingData

RoutingData routingData

scriptId

String scriptId

validateCallbackNumbers

Boolean validateCallbackNumbers

Class com.mypurecloud.sdk.v2.model.CreateCallbackResponse

class CreateCallbackResponse extends Object implements Serializable

Serialized Fields

callbackIdentifiers

List<CallbackIdentifier> callbackIdentifiers

conversation

DomainEntityRef conversation

Class com.mypurecloud.sdk.v2.model.CreateCallRequest

class CreateCallRequest extends Object implements Serializable

Serialized Fields

callerId

String callerId

callerIdName

String callerIdName

callFromQueueId

String callFromQueueId

callQueueId

String callQueueId

callUserId

String callUserId

conversationIds

List<String> conversationIds

externalContactId

String externalContactId

languageId

String languageId

participants

List<Destination> participants

phoneNumber

String phoneNumber

priority

Integer priority

routingSkillsIds

List<String> routingSkillsIds

uuiData

String uuiData

Class com.mypurecloud.sdk.v2.model.CreateCallResponse

class CreateCallResponse extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CreateCoachingAppointmentRequest

class CreateCoachingAppointmentRequest extends Object implements Serializable

Serialized Fields

attendeeIds

List<String> attendeeIds

conversationIds

List<String> conversationIds

dateStart

Date dateStart

description

String description

documentIds

List<String> documentIds

externalLinks

List<String> externalLinks

facilitatorId

String facilitatorId

lengthInMinutes

Integer lengthInMinutes

name

String name

wfmSchedule

WfmScheduleReference wfmSchedule

Class com.mypurecloud.sdk.v2.model.CreateEmailRequest

class CreateEmailRequest extends Object implements Serializable

Serialized Fields

attributes

Map<String,String> attributes

direction

CreateEmailRequest.DirectionEnum direction

externalContactId

String externalContactId

flowId

String flowId

fromAddress

String fromAddress

fromName

String fromName

htmlBody

String htmlBody

languageId

String languageId

priority

Long priority

provider

String provider

queueId

String queueId

skillIds

List<String> skillIds

subject

String subject

textBody

String textBody

toAddress

String toAddress

toName

String toName

Class com.mypurecloud.sdk.v2.model.CreateGeneralProgramTopicsDefinitionsJob

class CreateGeneralProgramTopicsDefinitionsJob extends Object implements Serializable

Serialized Fields

id

String id

state

CreateGeneralProgramTopicsDefinitionsJob.StateEnum state

Class com.mypurecloud.sdk.v2.model.CreateIntegrationRequest

class CreateIntegrationRequest extends Object implements Serializable

Serialized Fields

id

String id

integrationType

IntegrationType integrationType

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CreateManagementUnitApiRequest

class CreateManagementUnitApiRequest extends Object implements Serializable

Serialized Fields

businessUnitId

String businessUnitId

divisionId

String divisionId

name

String name

settings

CreateManagementUnitSettingsRequest settings

startDayOfWeek

CreateManagementUnitApiRequest.StartDayOfWeekEnum startDayOfWeek

timeZone

String timeZone

Class com.mypurecloud.sdk.v2.model.CreateManagementUnitSettingsRequest

class CreateManagementUnitSettingsRequest extends Object implements Serializable

Serialized Fields

adherence

AdherenceSettings adherence

scheduling

SchedulingSettingsRequest scheduling

shiftTrading

ShiftTradeSettings shiftTrading

shortTermForecasting

ShortTermForecastingSettings shortTermForecasting

timeOff

TimeOffRequestSettings timeOff

Class com.mypurecloud.sdk.v2.model.CreateMetric

class CreateMetric extends Object implements Serializable

Serialized Fields

externalMetricDefinitionId

String externalMetricDefinitionId

metricDefinitionId

String metricDefinitionId

name

String name

objective

CreateObjective objective

performanceProfileId

String performanceProfileId

precision

Integer precision

timeDisplayUnit

CreateMetric.TimeDisplayUnitEnum timeDisplayUnit

Class com.mypurecloud.sdk.v2.model.CreateObjective

class CreateObjective extends Object implements Serializable

Serialized Fields

dateStart

LocalDate dateStart

enabled

Boolean enabled

id

String id

mediaTypes

List<CreateObjective.MediaTypesEnum> mediaTypes

queueIds

List<String> queueIds

templateId

String templateId

topicIds

List<String> topicIds

topicIdsFilterType

CreateObjective.TopicIdsFilterTypeEnum topicIdsFilterType

zones

List<ObjectiveZone> zones

Class com.mypurecloud.sdk.v2.model.CreateOutboundMessagingConversationRequest

class CreateOutboundMessagingConversationRequest extends Object implements Serializable

Serialized Fields

externalContactId

String externalContactId

queueId

String queueId

toAddress

String toAddress

toAddressMessengerType

CreateOutboundMessagingConversationRequest.ToAddressMessengerTypeEnum toAddressMessengerType

useExistingConversation

Boolean useExistingConversation

Class com.mypurecloud.sdk.v2.model.CreatePerformanceProfile

class CreatePerformanceProfile extends Object implements Serializable

Serialized Fields

active

Boolean active

dateCreated

Date dateCreated

description

String description

division

WritableDivision division

id

String id

maxLeaderboardRankSize

Integer maxLeaderboardRankSize

memberCount

Integer memberCount

metricOrders

List<String> metricOrders

name

String name

reportingIntervals

List<ReportingInterval> reportingIntervals

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CreatePlanningGroupRequest

class CreatePlanningGroupRequest extends Object implements Serializable

Serialized Fields

name

String name

routePaths

List<RoutePathRequest> routePaths

serviceGoalTemplateId

String serviceGoalTemplateId

Class com.mypurecloud.sdk.v2.model.CreatePredictorRequest

class CreatePredictorRequest extends Object implements Serializable

Serialized Fields

kpi

String kpi

queueIds

List<String> queueIds

routingTimeoutSeconds

Integer routingTimeoutSeconds

schedule

PredictorSchedule schedule

workloadBalancingConfig

PredictorWorkloadBalancing workloadBalancingConfig

Class com.mypurecloud.sdk.v2.model.CreateQueueRequest

class CreateQueueRequest extends Object implements Serializable

Serialized Fields

acwSettings

AcwSettings acwSettings

agentOwnedRouting

AgentOwnedRouting agentOwnedRouting

autoAnswerOnly

Boolean autoAnswerOnly

bullseye

Bullseye bullseye

callingPartyName

String callingPartyName

callingPartyNumber

String callingPartyNumber

createdBy

String createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

defaultScripts

Map<String,Script> defaultScripts

description

String description

directRouting

DirectRouting directRouting

division

WritableDivision division

emailInQueueFlow

DomainEntityRef emailInQueueFlow

enableManualAssignment

Boolean enableManualAssignment

enableTranscription

Boolean enableTranscription

id

String id

joinedMemberCount

Integer joinedMemberCount

mediaSettings

QueueMediaSettings mediaSettings

memberCount

Integer memberCount

memberGroups

List<MemberGroup> memberGroups

messageInQueueFlow

DomainEntityRef messageInQueueFlow

modifiedBy

String modifiedBy

name

String name

onHoldPrompt

DomainEntityRef onHoldPrompt

outboundEmailAddress

QueueEmailAddress outboundEmailAddress

outboundMessagingAddresses

QueueMessagingAddresses outboundMessagingAddresses

peerId

String peerId

queueFlow

DomainEntityRef queueFlow

routingRules

List<RoutingRule> routingRules

selfUri

String selfUri

skillEvaluationMethod

CreateQueueRequest.SkillEvaluationMethodEnum skillEvaluationMethod

sourceQueueId

String sourceQueueId

userMemberCount

Integer userMemberCount

whisperPrompt

DomainEntityRef whisperPrompt

Class com.mypurecloud.sdk.v2.model.CreateResponseAssetRequest

class CreateResponseAssetRequest extends Object implements Serializable

Serialized Fields

contentMd5

String contentMd5

divisionId

String divisionId

name

String name

Class com.mypurecloud.sdk.v2.model.CreateResponseAssetResponse

class CreateResponseAssetResponse extends Object implements Serializable

Serialized Fields

headers

Map<String,String> headers

id

String id

url

String url

Class com.mypurecloud.sdk.v2.model.CreateSecureSession

class CreateSecureSession extends Object implements Serializable

Serialized Fields

disconnect

Boolean disconnect

flowId

String flowId

sourceParticipantId

String sourceParticipantId

userData

String userData

Class com.mypurecloud.sdk.v2.model.CreateServiceGoalTemplate

class CreateServiceGoalTemplate extends Object implements Serializable

Serialized Fields

abandonRate

BuAbandonRate abandonRate

averageSpeedOfAnswer

BuAverageSpeedOfAnswer averageSpeedOfAnswer

name

String name

serviceLevel

BuServiceLevel serviceLevel

Class com.mypurecloud.sdk.v2.model.CreateShareRequest

class CreateShareRequest extends Object implements Serializable

Serialized Fields

member

SharedEntity member

members

List<CreateShareRequestMember> members

memberType

CreateShareRequest.MemberTypeEnum memberType

sharedEntity

SharedEntity sharedEntity

sharedEntityType

CreateShareRequest.SharedEntityTypeEnum sharedEntityType

Class com.mypurecloud.sdk.v2.model.CreateShareRequestMember

class CreateShareRequestMember extends Object implements Serializable

Serialized Fields

member

MemberEntity member

memberType

CreateShareRequestMember.MemberTypeEnum memberType

Class com.mypurecloud.sdk.v2.model.CreateShareResponse

class CreateShareResponse extends Object implements Serializable

Serialized Fields

failed

List<Share> failed

id

String id

member

DomainEntityRef member

memberType

CreateShareResponse.MemberTypeEnum memberType

name

String name

selfUri

String selfUri

sharedBy

DomainEntityRef sharedBy

sharedEntity

DomainEntityRef sharedEntity

sharedEntityType

CreateShareResponse.SharedEntityTypeEnum sharedEntityType

succeeded

List<Share> succeeded

workspace

DomainEntityRef workspace

Class com.mypurecloud.sdk.v2.model.CreateTimeOffLimitRequest

class CreateTimeOffLimitRequest extends Object implements Serializable

Serialized Fields

defaultLimitMinutes

Integer defaultLimitMinutes

granularity

CreateTimeOffLimitRequest.GranularityEnum granularity

Class com.mypurecloud.sdk.v2.model.CreateTimeOffPlanRequest

class CreateTimeOffPlanRequest extends Object implements Serializable

Serialized Fields

active

Boolean active

activityCodeIds

List<String> activityCodeIds

autoApprovalRule

CreateTimeOffPlanRequest.AutoApprovalRuleEnum autoApprovalRule

daysBeforeStartToExpireFromWaitlist

Integer daysBeforeStartToExpireFromWaitlist

name

String name

timeOffLimitIds

List<String> timeOffLimitIds

Class com.mypurecloud.sdk.v2.model.CreateTriggerRequest

class CreateTriggerRequest extends Object implements Serializable

Serialized Fields

delayBySeconds

Integer delayBySeconds

description

String description

enabled

Boolean enabled

eventTTLSeconds

Integer eventTTLSeconds

matchCriteria

List<MatchCriteria> matchCriteria

name

String name

target

TriggerTarget target

topicName

String topicName

Class com.mypurecloud.sdk.v2.model.CreateUser

class CreateUser extends Object implements Serializable

Serialized Fields

addresses

List<Contact> addresses

department

String department

divisionId

String divisionId

email

String email

name

String name

password

String password

state

CreateUser.StateEnum state

title

String title

Class com.mypurecloud.sdk.v2.model.CreateUtilizationTagRequest

class CreateUtilizationTagRequest extends Object implements Serializable

Serialized Fields

name

String name

Class com.mypurecloud.sdk.v2.model.CreateWebChatConversationRequest

class CreateWebChatConversationRequest extends Object implements Serializable

Serialized Fields

deploymentId

String deploymentId

journeyContext

JourneyContext journeyContext

memberAuthToken

String memberAuthToken

memberInfo

GuestMemberInfo memberInfo

organizationId

String organizationId

routingTarget

WebChatRoutingTarget routingTarget

Class com.mypurecloud.sdk.v2.model.CreateWebChatConversationResponse

class CreateWebChatConversationResponse extends Object implements Serializable

Serialized Fields

eventStreamUri

String eventStreamUri

id

String id

jwt

String jwt

member

WebChatMemberInfo member

Class com.mypurecloud.sdk.v2.model.CreateWebChatMessageRequest

class CreateWebChatMessageRequest extends Object implements Serializable

Serialized Fields

body

String body

bodyType

CreateWebChatMessageRequest.BodyTypeEnum bodyType

Class com.mypurecloud.sdk.v2.model.CreateWebChatRequest

class CreateWebChatRequest extends Object implements Serializable

Serialized Fields

attributes

Map<String,String> attributes

customerName

String customerName

languageId

String languageId

priority

Long priority

provider

String provider

queueId

String queueId

skillIds

List<String> skillIds

Class com.mypurecloud.sdk.v2.model.CreateWorkPlan

class CreateWorkPlan extends Object implements Serializable

Serialized Fields

agents

List<UserReference> agents

constrainMaximumConsecutiveWorkingDays

Boolean constrainMaximumConsecutiveWorkingDays

constrainMaximumConsecutiveWorkingWeekends

Boolean constrainMaximumConsecutiveWorkingWeekends

constrainMinimumTimeBetweenShifts

Boolean constrainMinimumTimeBetweenShifts

constrainPaidTimeGranularity

Boolean constrainPaidTimeGranularity

constrainWeeklyPaidTime

Boolean constrainWeeklyPaidTime

enabled

Boolean enabled

flexibleWeeklyPaidTime

Boolean flexibleWeeklyPaidTime

maximumConsecutiveWorkingDays

Integer maximumConsecutiveWorkingDays

maximumConsecutiveWorkingWeekends

Integer maximumConsecutiveWorkingWeekends

maximumDays

Integer maximumDays

maximumDaysOffPerPlanningPeriod

Integer maximumDaysOffPerPlanningPeriod

maximumPaidMinutesPerPlanningPeriod

Integer maximumPaidMinutesPerPlanningPeriod

minimumConsecutiveNonWorkingMinutesPerWeek

Integer minimumConsecutiveNonWorkingMinutesPerWeek

minimumDaysOffPerPlanningPeriod

Integer minimumDaysOffPerPlanningPeriod

minimumPaidMinutesPerPlanningPeriod

Integer minimumPaidMinutesPerPlanningPeriod

minimumShiftStartDistanceMinutes

Integer minimumShiftStartDistanceMinutes

minimumTimeBetweenShiftsMinutes

Integer minimumTimeBetweenShiftsMinutes

minimumWorkingDaysPerWeek

Integer minimumWorkingDaysPerWeek

name

String name

optionalDays

SetWrapperDayOfWeek optionalDays

paidTimeGranularityMinutes

Integer paidTimeGranularityMinutes

shifts

List<CreateWorkPlanShift> shifts

shiftStartVariances

ListWrapperShiftStartVariance shiftStartVariances

shiftStartVarianceType

CreateWorkPlan.ShiftStartVarianceTypeEnum shiftStartVarianceType

weeklyExactPaidMinutes

Integer weeklyExactPaidMinutes

weeklyMaximumPaidMinutes

Integer weeklyMaximumPaidMinutes

weeklyMinimumPaidMinutes

Integer weeklyMinimumPaidMinutes

Class com.mypurecloud.sdk.v2.model.CreateWorkPlanActivity

class CreateWorkPlanActivity extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

countsAsContiguousWorkTime

Boolean countsAsContiguousWorkTime

countsAsPaidTime

Boolean countsAsPaidTime

description

String description

earliestStartTimeMinutes

Integer earliestStartTimeMinutes

exactStartTimeMinutes

Integer exactStartTimeMinutes

flexibleStartTime

Boolean flexibleStartTime

latestStartTimeMinutes

Integer latestStartTimeMinutes

lengthMinutes

Integer lengthMinutes

minimumLengthFromShiftEndMinutes

Integer minimumLengthFromShiftEndMinutes

minimumLengthFromShiftStartMinutes

Integer minimumLengthFromShiftStartMinutes

startTimeIncrementMinutes

Integer startTimeIncrementMinutes

startTimeIsRelativeToShiftStart

Boolean startTimeIsRelativeToShiftStart

Class com.mypurecloud.sdk.v2.model.CreateWorkPlanShift

class CreateWorkPlanShift extends Object implements Serializable

Serialized Fields

activities

List<CreateWorkPlanActivity> activities

constrainContiguousWorkTime

Boolean constrainContiguousWorkTime

constrainDayOff

Boolean constrainDayOff

constrainEarliestStopTime

Boolean constrainEarliestStopTime

constrainLatestStopTime

Boolean constrainLatestStopTime

constrainStopTime

Boolean constrainStopTime

dayOffRule

CreateWorkPlanShift.DayOffRuleEnum dayOffRule

days

SetWrapperDayOfWeek days

earliestStartTimeMinutesFromMidnight

Integer earliestStartTimeMinutesFromMidnight

earliestStopTimeMinutesFromMidnight

Integer earliestStopTimeMinutesFromMidnight

exactPaidTimeMinutes

Integer exactPaidTimeMinutes

exactStartTimeMinutesFromMidnight

Integer exactStartTimeMinutesFromMidnight

flexiblePaidTime

Boolean flexiblePaidTime

flexibleStartTime

Boolean flexibleStartTime

latestStartTimeMinutesFromMidnight

Integer latestStartTimeMinutesFromMidnight

latestStopTimeMinutesFromMidnight

Integer latestStopTimeMinutesFromMidnight

maximumContiguousWorkTimeMinutes

Integer maximumContiguousWorkTimeMinutes

maximumPaidTimeMinutes

Integer maximumPaidTimeMinutes

minimumContiguousWorkTimeMinutes

Integer minimumContiguousWorkTimeMinutes

minimumPaidTimeMinutes

Integer minimumPaidTimeMinutes

name

String name

startIncrementMinutes

Integer startIncrementMinutes

Class com.mypurecloud.sdk.v2.model.Credential

class Credential extends Object implements Serializable

Serialized Fields

credentialFields

Map<String,String> credentialFields

id

String id

name

String name

selfUri

String selfUri

type

CredentialType type

Class com.mypurecloud.sdk.v2.model.CredentialInfo

class CredentialInfo extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

id

String id

modifiedDate

Date modifiedDate

name

String name

selfUri

String selfUri

type

CredentialType type

Class com.mypurecloud.sdk.v2.model.CredentialInfoListing

class CredentialInfoListing extends Object implements Serializable

Serialized Fields

entities

List<CredentialInfo> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.CredentialSpecification

class CredentialSpecification extends Object implements Serializable

Serialized Fields

credentialTypes

List<String> credentialTypes

required

Boolean required

title

String title

Class com.mypurecloud.sdk.v2.model.CredentialType

class CredentialType extends Object implements Serializable

Serialized Fields

displayOrder

List<String> displayOrder

id

String id

name

String name

properties

Object properties

required

List<String> required

Class com.mypurecloud.sdk.v2.model.CredentialTypeListing

class CredentialTypeListing extends Object implements Serializable

Serialized Fields

entities

List<CredentialType> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.Criteria

class Criteria extends Object implements Serializable

Serialized Fields

key

String key

operator

Criteria.OperatorEnum operator

shouldIgnoreCase

Boolean shouldIgnoreCase

values

List<String> values

Class com.mypurecloud.sdk.v2.model.CriteriaCategoryInfo

class CriteriaCategoryInfo extends Object implements Serializable

Serialized Fields

categoryId

String categoryId

displayOrder

Integer displayOrder

Class com.mypurecloud.sdk.v2.model.CriteriaGroup

class CriteriaGroup extends Object implements Serializable

Serialized Fields

and

List<CriteriaItem> and

criteria

CriteriaItem criteria

not

List<CriteriaItem> not

or

List<CriteriaItem> or

Class com.mypurecloud.sdk.v2.model.CriteriaItem

class CriteriaItem extends Object implements Serializable

Serialized Fields

key

CriteriaItem.KeyEnum key

operator

CriteriaItem.OperatorEnum operator

value

String value

Class com.mypurecloud.sdk.v2.model.CriteriaQuery

class CriteriaQuery extends Object implements Serializable

Serialized Fields

query

List<CriteriaGroup> query

Class com.mypurecloud.sdk.v2.model.CrossPlatformCallMediaPolicy

class CrossPlatformCallMediaPolicy extends Object implements Serializable

Serialized Fields

actions

CrossPlatformPolicyActions actions

conditions

CallMediaPolicyConditions conditions

Class com.mypurecloud.sdk.v2.model.CrossPlatformChatMediaPolicy

class CrossPlatformChatMediaPolicy extends Object implements Serializable

Serialized Fields

actions

CrossPlatformPolicyActions actions

conditions

ChatMediaPolicyConditions conditions

Class com.mypurecloud.sdk.v2.model.CrossPlatformEmailMediaPolicy

class CrossPlatformEmailMediaPolicy extends Object implements Serializable

Serialized Fields

actions

CrossPlatformPolicyActions actions

conditions

EmailMediaPolicyConditions conditions

Class com.mypurecloud.sdk.v2.model.CrossPlatformMediaPolicies

class CrossPlatformMediaPolicies extends Object implements Serializable

Serialized Fields

callPolicy

CrossPlatformCallMediaPolicy callPolicy

chatPolicy

CrossPlatformChatMediaPolicy chatPolicy

emailPolicy

CrossPlatformEmailMediaPolicy emailPolicy

messagePolicy

CrossPlatformMessageMediaPolicy messagePolicy

Class com.mypurecloud.sdk.v2.model.CrossPlatformMessageMediaPolicy

class CrossPlatformMessageMediaPolicy extends Object implements Serializable

Serialized Fields

actions

CrossPlatformPolicyActions actions

conditions

MessageMediaPolicyConditions conditions

Class com.mypurecloud.sdk.v2.model.CrossPlatformPolicy

class CrossPlatformPolicy extends Object implements Serializable

Serialized Fields

actions

CrossPlatformPolicyActions actions

conditions

PolicyConditions conditions

createdDate

Date createdDate

description

String description

enabled

Boolean enabled

id

String id

mediaPolicies

CrossPlatformMediaPolicies mediaPolicies

modifiedDate

Date modifiedDate

name

String name

order

Integer order

policyErrors

PolicyErrors policyErrors

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CrossPlatformPolicyActions

class CrossPlatformPolicyActions extends Object implements Serializable

Serialized Fields

alwaysDelete

Boolean alwaysDelete

assignCalibrations

List<CalibrationAssignment> assignCalibrations

assignEvaluations

List<EvaluationAssignment> assignEvaluations

assignMeteredAssignmentByAgent

List<MeteredAssignmentByAgent> assignMeteredAssignmentByAgent

assignMeteredEvaluations

List<MeteredEvaluationAssignment> assignMeteredEvaluations

deleteRecording

Boolean deleteRecording

integrationExport

IntegrationExport integrationExport

mediaTranscriptions

List<MediaTranscription> mediaTranscriptions

retainRecording

Boolean retainRecording

retentionDuration

RetentionDuration retentionDuration

Class com.mypurecloud.sdk.v2.model.CrossPlatformPolicyCreate

class CrossPlatformPolicyCreate extends Object implements Serializable

Serialized Fields

actions

CrossPlatformPolicyActions actions

conditions

PolicyConditions conditions

createdDate

Date createdDate

description

String description

enabled

Boolean enabled

id

String id

mediaPolicies

CrossPlatformMediaPolicies mediaPolicies

modifiedDate

Date modifiedDate

name

String name

order

Integer order

policyErrors

PolicyErrors policyErrors

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CrossPlatformPolicyUpdate

class CrossPlatformPolicyUpdate extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

Class com.mypurecloud.sdk.v2.model.CtaButtonStyleProperties

class CtaButtonStyleProperties extends Object implements Serializable

Serialized Fields

backgroundColor

String backgroundColor

color

String color

font

String font

fontSize

String fontSize

textAlign

CtaButtonStyleProperties.TextAlignEnum textAlign

Class com.mypurecloud.sdk.v2.model.CurrentUserScheduleRequestBody

class CurrentUserScheduleRequestBody extends Object implements Serializable

Serialized Fields

endDate

Date endDate

loadFullWeeks

Boolean loadFullWeeks

startDate

Date startDate

Class com.mypurecloud.sdk.v2.model.CursorContactListing

class CursorContactListing extends Object implements Serializable

Serialized Fields

cursors

Cursors cursors

entities

List<ExternalContact> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CursorNoteListing

class CursorNoteListing extends Object implements Serializable

Serialized Fields

cursors

Cursors cursors

entities

List<Note> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CursorOrganizationListing

class CursorOrganizationListing extends Object implements Serializable

Serialized Fields

cursors

Cursors cursors

entities

List<ExternalOrganization> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.CursorRelationshipListing

class CursorRelationshipListing extends Object implements Serializable

Serialized Fields

cursors

Cursors cursors

entities

List<Relationship> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.Cursors

class Cursors extends Object implements Serializable

Serialized Fields

after

String after

before

String before

Class com.mypurecloud.sdk.v2.model.CustomerEndDetailEventTopicCustomerEndEvent

class CustomerEndDetailEventTopicCustomerEndEvent extends Object implements Serializable

Serialized Fields

addressFrom

String addressFrom

addressTo

String addressTo

ani

String ani

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Integer callbackScheduledTime

callbackUserName

String callbackUserName

conversationExternalContactIds

List<String> conversationExternalContactIds

conversationExternalOrganizationIds

List<String> conversationExternalOrganizationIds

conversationId

String conversationId

direction

CustomerEndDetailEventTopicCustomerEndEvent.DirectionEnum direction

disconnectType

CustomerEndDetailEventTopicCustomerEndEvent.DisconnectTypeEnum disconnectType

dnis

String dnis

eventTime

Integer eventTime

externalContactId

String externalContactId

externalOrganizationId

String externalOrganizationId

interactingDurationMs

Integer interactingDurationMs

mediaType

CustomerEndDetailEventTopicCustomerEndEvent.MediaTypeEnum mediaType

messageType

CustomerEndDetailEventTopicCustomerEndEvent.MessageTypeEnum messageType

participantId

String participantId

provider

String provider

sessionId

String sessionId

subject

String subject

Class com.mypurecloud.sdk.v2.model.CustomerInteractionCenter

class CustomerInteractionCenter extends Object implements Serializable

Serialized Fields

certificate

String certificate

certificates

List<String> certificates

disabled

Boolean disabled

id

String id

issuerURI

String issuerURI

name

String name

relyingPartyIdentifier

String relyingPartyIdentifier

selfUri

String selfUri

sloBinding

String sloBinding

sloURI

String sloURI

ssoTargetURI

String ssoTargetURI

Class com.mypurecloud.sdk.v2.model.CustomerStartDetailEventTopicCustomerStartEvent

class CustomerStartDetailEventTopicCustomerStartEvent extends Object implements Serializable

Serialized Fields

addressFrom

String addressFrom

addressTo

String addressTo

ani

String ani

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Integer callbackScheduledTime

callbackUserName

String callbackUserName

conversationExternalContactIds

List<String> conversationExternalContactIds

conversationExternalOrganizationIds

List<String> conversationExternalOrganizationIds

conversationId

String conversationId

direction

CustomerStartDetailEventTopicCustomerStartEvent.DirectionEnum direction

dnis

String dnis

eventTime

Integer eventTime

externalContactId

String externalContactId

externalOrganizationId

String externalOrganizationId

mediaType

CustomerStartDetailEventTopicCustomerStartEvent.MediaTypeEnum mediaType

messageType

CustomerStartDetailEventTopicCustomerStartEvent.MessageTypeEnum messageType

participantId

String participantId

provider

String provider

sessionId

String sessionId

subject

String subject

Class com.mypurecloud.sdk.v2.model.CustomEventAttribute

class CustomEventAttribute extends Object implements Serializable

Serialized Fields

dataType

String dataType

value

String value

Class com.mypurecloud.sdk.v2.model.CustomEventAttributeList

class CustomEventAttributeList extends Object implements Serializable

Serialized Fields

dataType

String dataType

values

List<String> values

Class com.mypurecloud.sdk.v2.model.CustomI18nLabels

class CustomI18nLabels extends Object implements Serializable

Serialized Fields

language

String language

localizedLabels

List<LocalizedLabels> localizedLabels

Class com.mypurecloud.sdk.v2.model.DailyPossibleShift

class DailyPossibleShift extends Object implements Serializable

Serialized Fields

dayOfWeek

DailyPossibleShift.DayOfWeekEnum dayOfWeek

earliestShiftStartMinutesFromMidnight

Integer earliestShiftStartMinutesFromMidnight

intervalScheduleProbabilities

List<Integer> intervalScheduleProbabilities

maximumPaidTimeMinutes

Integer maximumPaidTimeMinutes

minimumPaidTimeMinutes

Integer minimumPaidTimeMinutes

required

Boolean required

Class com.mypurecloud.sdk.v2.model.DataActionConditionPredicate

class DataActionConditionPredicate extends Object implements Serializable

Serialized Fields

comparisonValue

String comparisonValue

inverted

Boolean inverted

outputField

String outputField

outputFieldMissingResolution

Boolean outputFieldMissingResolution

outputOperator

DataActionConditionPredicate.OutputOperatorEnum outputOperator

Class com.mypurecloud.sdk.v2.model.DataActionConditionSettings

class DataActionConditionSettings extends Object implements Serializable

Serialized Fields

contactColumnToDataActionFieldMappings

List<DataActionContactColumnFieldMapping> contactColumnToDataActionFieldMappings

contactIdField

String contactIdField

dataActionId

String dataActionId

dataNotFoundResolution

Boolean dataNotFoundResolution

predicates

List<DigitalDataActionConditionPredicate> predicates

Class com.mypurecloud.sdk.v2.model.DataActionContactColumnFieldMapping

class DataActionContactColumnFieldMapping extends Object implements Serializable

Serialized Fields

contactColumnName

String contactColumnName

dataActionField

String dataActionField

Class com.mypurecloud.sdk.v2.model.DataAvailabilityResponse

class DataAvailabilityResponse extends Object implements Serializable

Serialized Fields

dataAvailabilityDate

Date dataAvailabilityDate

Class com.mypurecloud.sdk.v2.model.DataSchema

class DataSchema extends Object implements Serializable

Serialized Fields

appliesTo

List<DataSchema.AppliesToEnum> appliesTo

createdBy

DomainEntityRef createdBy

dateCreated

Date dateCreated

enabled

Boolean enabled

id

String id

jsonSchema

JsonSchemaDocument jsonSchema

name

String name

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.DataSchemaListing

class DataSchemaListing extends Object implements Serializable

Serialized Fields

entities

List<DataSchema> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DataTable

class DataTable extends Object implements Serializable

Serialized Fields

description

String description

division

WritableDivision division

id

String id

name

String name

schema

JsonSchemaDocument schema

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DataTableExportJob

class DataTableExportJob extends Object implements Serializable

Serialized Fields

countRecordsProcessed

Integer countRecordsProcessed

dateCompleted

Date dateCompleted

dateCreated

Date dateCreated

downloadURI

String downloadURI

errorInformation

ErrorBody errorInformation

id

String id

name

String name

owner

AddressableEntityRef owner

selfUri

String selfUri

status

DataTableExportJob.StatusEnum status

Class com.mypurecloud.sdk.v2.model.DataTableImportEntityListing

class DataTableImportEntityListing extends Object implements Serializable

Serialized Fields

entities

List<DataTableImportJob> entities

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

total

Long total

Class com.mypurecloud.sdk.v2.model.DataTableImportJob

class DataTableImportJob extends Object implements Serializable

Serialized Fields

countRecordsDeleted

Integer countRecordsDeleted

countRecordsFailed

Integer countRecordsFailed

countRecordsUpdated

Integer countRecordsUpdated

dateCompleted

Date dateCompleted

dateCreated

Date dateCreated

errorInformation

ErrorBody errorInformation

id

String id

importMode

DataTableImportJob.ImportModeEnum importMode

name

String name

owner

AddressableEntityRef owner

selfUri

String selfUri

status

DataTableImportJob.StatusEnum status

uploadURI

String uploadURI

Class com.mypurecloud.sdk.v2.model.DataTableRowEntityListing

class DataTableRowEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Map<String,Object>> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DataTablesDomainEntityListing

class DataTablesDomainEntityListing extends Object implements Serializable

Serialized Fields

entities

List<DataTable> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DateRange

class DateRange extends Object implements Serializable

Serialized Fields

endDate

String endDate

startDate

String startDate

Class com.mypurecloud.sdk.v2.model.DateRangeWithOptionalEnd

class DateRangeWithOptionalEnd extends Object implements Serializable

Serialized Fields

endBusinessUnitDate

LocalDate endBusinessUnitDate

startBusinessUnitDate

LocalDate startBusinessUnitDate

Class com.mypurecloud.sdk.v2.model.DefaultGreetingList

class DefaultGreetingList extends Object implements Serializable

Serialized Fields

createdBy

String createdBy

createdDate

Date createdDate

greetings

Map<String,Greeting> greetings

id

String id

modifiedBy

String modifiedBy

modifiedDate

Date modifiedDate

name

String name

owner

GreetingOwner owner

ownerType

DefaultGreetingList.OwnerTypeEnum ownerType

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DefaultObjective

class DefaultObjective extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

id

String id

mediaTypes

List<DefaultObjective.MediaTypesEnum> mediaTypes

queues

List<AddressableEntityRef> queues

templateId

String templateId

topicIdsFilterType

DefaultObjective.TopicIdsFilterTypeEnum topicIdsFilterType

topics

List<AddressableEntityRef> topics

zones

List<ObjectiveZone> zones

Class com.mypurecloud.sdk.v2.model.DeletableUserReference

class DeletableUserReference extends Object implements Serializable

Serialized Fields

delete

Boolean delete

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DeleteRetention

class DeleteRetention extends Object implements Serializable

Serialized Fields

days

Integer days

Class com.mypurecloud.sdk.v2.model.Dependency

class Dependency extends Object implements Serializable

Serialized Fields

deleted

Boolean deleted

id

String id

name

String name

selfUri

String selfUri

stateUnknown

Boolean stateUnknown

type

Dependency.TypeEnum type

updated

Boolean updated

version

String version

Class com.mypurecloud.sdk.v2.model.DependencyObject

class DependencyObject extends Object implements Serializable

Serialized Fields

consumedResources

List<Dependency> consumedResources

consumingResources

List<Dependency> consumingResources

deleted

Boolean deleted

id

String id

name

String name

selfUri

String selfUri

stateUnknown

Boolean stateUnknown

type

DependencyObject.TypeEnum type

updated

Boolean updated

version

String version

Class com.mypurecloud.sdk.v2.model.DependencyObjectEntityListing

class DependencyObjectEntityListing extends Object implements Serializable

Serialized Fields

entities

List<DependencyObject> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DependencyStatus

class DependencyStatus extends Object implements Serializable

Serialized Fields

buildId

String buildId

client

DomainEntityRef client

dateCompleted

Date dateCompleted

dateStarted

Date dateStarted

failedObjects

List<FailedObject> failedObjects

id

String id

name

String name

selfUri

String selfUri

status

DependencyStatus.StatusEnum status

user

User user

Class com.mypurecloud.sdk.v2.model.DependencyType

class DependencyType extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

versioned

Boolean versioned

Class com.mypurecloud.sdk.v2.model.DependencyTypeEntityListing

class DependencyTypeEntityListing extends Object implements Serializable

Serialized Fields

entities

List<DependencyType> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.Destination

class Destination extends Object implements Serializable

Serialized Fields

address

String address

name

String name

queueId

String queueId

userId

String userId

Class com.mypurecloud.sdk.v2.model.Detail

class Detail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.DetectedDialogAct

class DetectedDialogAct extends Object implements Serializable

Serialized Fields

name

String name

probability

Double probability

Class com.mypurecloud.sdk.v2.model.DetectedIntent

class DetectedIntent extends Object implements Serializable

Serialized Fields

entities

List<DetectedNamedEntity> entities

name

String name

probability

Double probability

Class com.mypurecloud.sdk.v2.model.DetectedNamedEntity

class DetectedNamedEntity extends Object implements Serializable

Serialized Fields

entityType

String entityType

name

String name

probability

Double probability

value

DetectedNamedEntityValue value

Class com.mypurecloud.sdk.v2.model.DetectedNamedEntityValue

class DetectedNamedEntityValue extends Object implements Serializable

Serialized Fields

raw

String raw

resolved

String resolved

Class com.mypurecloud.sdk.v2.model.DevelopmentActivity

class DevelopmentActivity extends Object implements Serializable

Serialized Fields

archivalMode

DevelopmentActivity.ArchivalModeEnum archivalMode

attendees

List<UserReference> attendees

createdBy

UserReference createdBy

dateCompleted

Date dateCompleted

dateCreated

Date dateCreated

dateDue

Date dateDue

facilitator

UserReference facilitator

id

String id

isLatest

Boolean isLatest

isModuleArchived

Boolean isModuleArchived

isOverdue

Boolean isOverdue

isPassed

Boolean isPassed

name

String name

percentageScore

Float percentageScore

selfUri

String selfUri

status

DevelopmentActivity.StatusEnum status

type

DevelopmentActivity.TypeEnum type

Class com.mypurecloud.sdk.v2.model.DevelopmentActivityAggregateParam

class DevelopmentActivityAggregateParam extends Object implements Serializable

Serialized Fields

filter

DevelopmentActivityAggregateQueryRequestFilter filter

groupBy

List<DevelopmentActivityAggregateParam.GroupByEnum> groupBy

interval

String interval

metrics

List<DevelopmentActivityAggregateParam.MetricsEnum> metrics

Class com.mypurecloud.sdk.v2.model.DevelopmentActivityAggregateQueryRequestClause

class DevelopmentActivityAggregateQueryRequestClause extends Object implements Serializable

Serialized Fields

predicates

List<DevelopmentActivityAggregateQueryRequestPredicate> predicates

type

DevelopmentActivityAggregateQueryRequestClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.DevelopmentActivityAggregateQueryRequestFilter

class DevelopmentActivityAggregateQueryRequestFilter extends Object implements Serializable

Serialized Fields

clauses

List<DevelopmentActivityAggregateQueryRequestClause> clauses

type

DevelopmentActivityAggregateQueryRequestFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.DevelopmentActivityAggregateQueryRequestPredicate

class DevelopmentActivityAggregateQueryRequestPredicate extends Object implements Serializable

Serialized Fields

dimension

DevelopmentActivityAggregateQueryRequestPredicate.DimensionEnum dimension

value

String value

Class com.mypurecloud.sdk.v2.model.DevelopmentActivityAggregateQueryResponseData

class DevelopmentActivityAggregateQueryResponseData extends Object implements Serializable

Serialized Fields

interval

String interval

metrics

List<DevelopmentActivityAggregateQueryResponseMetric> metrics

Class com.mypurecloud.sdk.v2.model.DevelopmentActivityAggregateQueryResponseGroupedData

class DevelopmentActivityAggregateQueryResponseGroupedData extends Object implements Serializable

Serialized Fields

data

List<DevelopmentActivityAggregateQueryResponseData> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.DevelopmentActivityAggregateQueryResponseMetric

class DevelopmentActivityAggregateQueryResponseMetric extends Object implements Serializable

Serialized Fields

metric

DevelopmentActivityAggregateQueryResponseMetric.MetricEnum metric

stats

DevelopmentActivityAggregateQueryResponseStatistics stats

Class com.mypurecloud.sdk.v2.model.DevelopmentActivityAggregateQueryResponseStatistics

class DevelopmentActivityAggregateQueryResponseStatistics extends Object implements Serializable

Serialized Fields

count

Integer count

max

BigDecimal max

min

BigDecimal min

sum

BigDecimal sum

Class com.mypurecloud.sdk.v2.model.DevelopmentActivityAggregateResponse

class DevelopmentActivityAggregateResponse extends Object implements Serializable

Serialized Fields

results

List<DevelopmentActivityAggregateQueryResponseGroupedData> results

Class com.mypurecloud.sdk.v2.model.DevelopmentActivityListing

class DevelopmentActivityListing extends Object implements Serializable

Serialized Fields

entities

List<DevelopmentActivity> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.Device

class Device extends Object implements Serializable

Serialized Fields

category

Device.CategoryEnum category

fingerprint

String fingerprint

isMobile

Boolean isMobile

osFamily

String osFamily

osVersion

String osVersion

screenHeight

Integer screenHeight

screenWidth

Integer screenWidth

type

String type

Class com.mypurecloud.sdk.v2.model.DialerAction

class DialerAction extends Object implements Serializable

Serialized Fields

actionTypeName

DialerAction.ActionTypeNameEnum actionTypeName

agentWrapupField

String agentWrapupField

callAnalysisResultField

String callAnalysisResultField

contactColumnToDataActionFieldMappings

List<ContactColumnToDataActionFieldMapping> contactColumnToDataActionFieldMappings

contactIdField

String contactIdField

dataAction

DomainEntityRef dataAction

properties

Map<String,String> properties

type

DialerAction.TypeEnum type

updateOption

DialerAction.UpdateOptionEnum updateOption

Class com.mypurecloud.sdk.v2.model.DialerAttemptLimitsConfigChangeAttemptLimits

class DialerAttemptLimitsConfigChangeAttemptLimits extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

breadthFirstRecalls

Boolean breadthFirstRecalls

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

maxAttemptsPerContact

Integer maxAttemptsPerContact

maxAttemptsPerNumber

Integer maxAttemptsPerNumber

name

String name

recallEntries

Map<String,DialerAttemptLimitsConfigChangeRecallEntry> recallEntries

resetPeriod

DialerAttemptLimitsConfigChangeAttemptLimits.ResetPeriodEnum resetPeriod

timeZoneId

String timeZoneId

version

Integer version

Class com.mypurecloud.sdk.v2.model.DialerAttemptLimitsConfigChangeObject

class DialerAttemptLimitsConfigChangeObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.DialerAttemptLimitsConfigChangeRecallEntry

class DialerAttemptLimitsConfigChangeRecallEntry extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

minutesBetweenAttempts

Integer minutesBetweenAttempts

nbrAttempts

Integer nbrAttempts

Class com.mypurecloud.sdk.v2.model.DialerAuditRequest

class DialerAuditRequest extends Object implements Serializable

Serialized Fields

facets

List<AuditFacet> facets

filters

List<AuditFilter> filters

queryFields

List<String> queryFields

queryPhrase

String queryPhrase

Class com.mypurecloud.sdk.v2.model.DialerCallabletimesetConfigChangeCallableTime

class DialerCallabletimesetConfigChangeCallableTime extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

timeSlots

List<DialerCallabletimesetConfigChangeTimeSlot> timeSlots

timeZoneId

String timeZoneId

Class com.mypurecloud.sdk.v2.model.DialerCallabletimesetConfigChangeCallableTimeSet

class DialerCallabletimesetConfigChangeCallableTimeSet extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

callableTimes

List<DialerCallabletimesetConfigChangeCallableTime> callableTimes

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

name

String name

version

Integer version

Class com.mypurecloud.sdk.v2.model.DialerCallabletimesetConfigChangeObject

class DialerCallabletimesetConfigChangeObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.DialerCallabletimesetConfigChangeTimeSlot

class DialerCallabletimesetConfigChangeTimeSlot extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

day

Integer day

startTime

String startTime

stopTime

String stopTime

Class com.mypurecloud.sdk.v2.model.DialerCampaignConfigChangeCampaign

class DialerCampaignConfigChangeCampaign extends Object implements Serializable

Serialized Fields

abandonRate

BigDecimal abandonRate

additionalProperties

Map<String,Object> additionalProperties

agentOwnedColumn

String agentOwnedColumn

callableTimeSet

DialerCampaignConfigChangeUriReference callableTimeSet

callAnalysisLanguage

String callAnalysisLanguage

callAnalysisResponseSet

DialerCampaignConfigChangeUriReference callAnalysisResponseSet

callerAddress

String callerAddress

callerName

String callerName

campaignStatus

DialerCampaignConfigChangeCampaign.CampaignStatusEnum campaignStatus

contactList

DialerCampaignConfigChangeUriReference contactList

contactListFilters

List<DialerCampaignConfigChangeUriReference> contactListFilters

contactSort

DialerCampaignConfigChangeContactSort contactSort

contactSorts

List<DialerCampaignConfigChangeContactSort> contactSorts

dateCreated

Date dateCreated

dateModified

Date dateModified

dialingMode

DialerCampaignConfigChangeCampaign.DialingModeEnum dialingMode

division

DialerCampaignConfigChangeUriReference division

dncLists

List<DialerCampaignConfigChangeUriReference> dncLists

edgeGroup

DialerCampaignConfigChangeUriReference edgeGroup

errors

List<DialerCampaignConfigChangeRestErrorDetail> errors

id

String id

name

String name

noAnswerTimeout

Integer noAnswerTimeout

outboundLineCount

Integer outboundLineCount

phoneColumns

List<DialerCampaignConfigChangePhoneColumn> phoneColumns

previewTimeOutSeconds

Integer previewTimeOutSeconds

priority

Integer priority

queue

DialerCampaignConfigChangeUriReference queue

ruleSets

List<DialerCampaignConfigChangeUriReference> ruleSets

script

DialerCampaignConfigChangeUriReference script

singleNumberPreview

Boolean singleNumberPreview

site

DialerCampaignConfigChangeUriReference site

skipPreviewDisabled

Boolean skipPreviewDisabled

version

Integer version

Class com.mypurecloud.sdk.v2.model.DialerCampaignConfigChangeContactSort

class DialerCampaignConfigChangeContactSort extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

direction

DialerCampaignConfigChangeContactSort.DirectionEnum direction

fieldName

String fieldName

numeric

Boolean numeric

Class com.mypurecloud.sdk.v2.model.DialerCampaignConfigChangeObject

class DialerCampaignConfigChangeObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.DialerCampaignConfigChangePhoneColumn

class DialerCampaignConfigChangePhoneColumn extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

columnName

String columnName

type

String type

Class com.mypurecloud.sdk.v2.model.DialerCampaignConfigChangeRestErrorDetail

class DialerCampaignConfigChangeRestErrorDetail extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

details

String details

error

String error

Class com.mypurecloud.sdk.v2.model.DialerCampaignConfigChangeUriReference

class DialerCampaignConfigChangeUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.DialerCampaignProgressEventCampaignProgress

class DialerCampaignProgressEventCampaignProgress extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

campaign

DialerCampaignProgressEventUriReference campaign

numberOfContactsCalled

BigDecimal numberOfContactsCalled

numberOfContactsMessaged

BigDecimal numberOfContactsMessaged

percentage

Integer percentage

totalNumberOfContacts

BigDecimal totalNumberOfContacts

Class com.mypurecloud.sdk.v2.model.DialerCampaignProgressEventObject

class DialerCampaignProgressEventObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.DialerCampaignProgressEventUriReference

class DialerCampaignProgressEventUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.DialerCampaignRuleConfigChangeCampaignRule

class DialerCampaignRuleConfigChangeCampaignRule extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

campaignRuleActions

List<DialerCampaignRuleConfigChangeCampaignRuleAction> campaignRuleActions

campaignRuleConditions

List<DialerCampaignRuleConfigChangeCampaignRuleCondition> campaignRuleConditions

campaignRuleEntities

DialerCampaignRuleConfigChangeCampaignRuleEntities campaignRuleEntities

dateCreated

Date dateCreated

dateModified

Date dateModified

enabled

Boolean enabled

id

String id

matchAnyConditions

Boolean matchAnyConditions

name

String name

version

Integer version

Class com.mypurecloud.sdk.v2.model.DialerCampaignRuleConfigChangeCampaignRuleAction

class DialerCampaignRuleConfigChangeCampaignRuleAction extends Object implements Serializable

Serialized Fields

actionType

DialerCampaignRuleConfigChangeCampaignRuleAction.ActionTypeEnum actionType

additionalProperties

Map<String,Object> additionalProperties

campaignRuleActionEntities

DialerCampaignRuleConfigChangeCampaignRuleActionEntities campaignRuleActionEntities

id

String id

parameters

Map<String,String> parameters

Class com.mypurecloud.sdk.v2.model.DialerCampaignRuleConfigChangeCampaignRuleActionEntities

class DialerCampaignRuleConfigChangeCampaignRuleActionEntities extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

campaigns

List<DialerCampaignRuleConfigChangeUriReference> campaigns

sequences

List<DialerCampaignRuleConfigChangeUriReference> sequences

useTriggeringEntity

Boolean useTriggeringEntity

Class com.mypurecloud.sdk.v2.model.DialerCampaignRuleConfigChangeCampaignRuleCondition

class DialerCampaignRuleConfigChangeCampaignRuleCondition extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

conditionType

DialerCampaignRuleConfigChangeCampaignRuleCondition.ConditionTypeEnum conditionType

id

String id

parameters

Map<String,String> parameters

Class com.mypurecloud.sdk.v2.model.DialerCampaignRuleConfigChangeCampaignRuleEntities

class DialerCampaignRuleConfigChangeCampaignRuleEntities extends Object implements Serializable

Serialized Fields

campaigns

List<DialerCampaignRuleConfigChangeUriReference> campaigns

sequences

List<DialerCampaignRuleConfigChangeUriReference> sequences

Class com.mypurecloud.sdk.v2.model.DialerCampaignRuleConfigChangeObject

class DialerCampaignRuleConfigChangeObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.DialerCampaignRuleConfigChangeUriReference

class DialerCampaignRuleConfigChangeUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.DialerCampaignScheduleConfigChangeCampaignSchedule

class DialerCampaignScheduleConfigChangeCampaignSchedule extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

campaign

DialerCampaignScheduleConfigChangeUriReference campaign

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

intervals

List<DialerCampaignScheduleConfigChangeScheduleInterval> intervals

name

String name

timeZone

String timeZone

version

Integer version

Class com.mypurecloud.sdk.v2.model.DialerCampaignScheduleConfigChangeObject

class DialerCampaignScheduleConfigChangeObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.DialerCampaignScheduleConfigChangeScheduleInterval

class DialerCampaignScheduleConfigChangeScheduleInterval extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

end

String end

start

String start

Class com.mypurecloud.sdk.v2.model.DialerCampaignScheduleConfigChangeUriReference

class DialerCampaignScheduleConfigChangeUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.DialerContact

class DialerContact extends Object implements Serializable

Serialized Fields

callable

Boolean callable

callRecords

Map<String,CallRecord> callRecords

configurationOverrides

ConfigurationOverrides configurationOverrides

contactableStatus

Map<String,ContactableStatus> contactableStatus

contactColumnTimeZones

Map<String,ContactColumnTimeZone> contactColumnTimeZones

contactListId

String contactListId

data

Map<String,String> data

id

String id

latestEmailEvaluations

Map<String,MessageEvaluation> latestEmailEvaluations

latestSmsEvaluations

Map<String,MessageEvaluation> latestSmsEvaluations

name

String name

phoneNumberStatus

Map<String,PhoneNumberStatus> phoneNumberStatus

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DialerContactId

class DialerContactId extends Object implements Serializable

Serialized Fields

contactListId

String contactListId

id

String id

Class com.mypurecloud.sdk.v2.model.DialerContactlistConfigChangeContactList

class DialerContactlistConfigChangeContactList extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

attemptLimits

DialerContactlistConfigChangeUriReference attemptLimits

automaticTimeZoneMapping

Boolean automaticTimeZoneMapping

columnNames

List<String> columnNames

dateCreated

Date dateCreated

dateModified

Date dateModified

division

DialerContactlistConfigChangeUriReference division

emailColumns

List<DialerContactlistConfigChangeEmailColumn> emailColumns

id

String id

importStatus

DialerContactlistConfigChangeImportStatus importStatus

name

String name

phoneColumns

List<DialerContactlistConfigChangeContactPhoneNumberColumn> phoneColumns

previewModeAcceptedValues

List<String> previewModeAcceptedValues

previewModeColumnName

String previewModeColumnName

size

Integer size

version

Integer version

zipCodeColumnName

String zipCodeColumnName

Class com.mypurecloud.sdk.v2.model.DialerContactlistConfigChangeContactPhoneNumberColumn

class DialerContactlistConfigChangeContactPhoneNumberColumn extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

callableTimeColumn

String callableTimeColumn

columnName

String columnName

type

String type

Class com.mypurecloud.sdk.v2.model.DialerContactlistConfigChangeEmailColumn

class DialerContactlistConfigChangeEmailColumn extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

columnName

String columnName

type

String type

Class com.mypurecloud.sdk.v2.model.DialerContactlistConfigChangeImportStatus

class DialerContactlistConfigChangeImportStatus extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

completedRecords

Integer completedRecords

failureReason

String failureReason

importState

DialerContactlistConfigChangeImportStatus.ImportStateEnum importState

percentageComplete

Integer percentageComplete

totalRecords

Integer totalRecords

Class com.mypurecloud.sdk.v2.model.DialerContactlistConfigChangeObject

class DialerContactlistConfigChangeObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.DialerContactlistConfigChangeUriReference

class DialerContactlistConfigChangeUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.DialerContactlistfilterConfigChangeContactListFilter

class DialerContactlistfilterConfigChangeContactListFilter extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

clauses

List<DialerContactlistfilterConfigChangeFilterClause> clauses

contactList

DialerContactlistfilterConfigChangeUriReference contactList

contactListColumns

List<String> contactListColumns

dateCreated

Date dateCreated

dateModified

Date dateModified

filterType

DialerContactlistfilterConfigChangeContactListFilter.FilterTypeEnum filterType

id

String id

name

String name

version

Integer version

Class com.mypurecloud.sdk.v2.model.DialerContactlistfilterConfigChangeFilterClause

class DialerContactlistfilterConfigChangeFilterClause extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

filterType

DialerContactlistfilterConfigChangeFilterClause.FilterTypeEnum filterType

predicates

List<DialerContactlistfilterConfigChangeFilterPredicate> predicates

Class com.mypurecloud.sdk.v2.model.DialerContactlistfilterConfigChangeFilterPredicate

class DialerContactlistfilterConfigChangeFilterPredicate extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

column

String column

columnType

DialerContactlistfilterConfigChangeFilterPredicate.ColumnTypeEnum columnType

inverted

Boolean inverted

operator

DialerContactlistfilterConfigChangeFilterPredicate.OperatorEnum operator

range

DialerContactlistfilterConfigChangeRange range

value

String value

Class com.mypurecloud.sdk.v2.model.DialerContactlistfilterConfigChangeObject

class DialerContactlistfilterConfigChangeObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.DialerContactlistfilterConfigChangeRange

class DialerContactlistfilterConfigChangeRange extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

inSet

List<String> inSet

max

String max

maxInclusive

Boolean maxInclusive

min

String min

minInclusive

Boolean minInclusive

Class com.mypurecloud.sdk.v2.model.DialerContactlistfilterConfigChangeUriReference

class DialerContactlistfilterConfigChangeUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.DialerDnclistConfigChangeDncList

class DialerDnclistConfigChangeDncList extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

contactMethod

DialerDnclistConfigChangeDncList.ContactMethodEnum contactMethod

dateCreated

Date dateCreated

dateModified

Date dateModified

division

DialerDnclistConfigChangeUriReference division

dncCodes

List<String> dncCodes

dncSourceType

DialerDnclistConfigChangeDncList.DncSourceTypeEnum dncSourceType

id

String id

importStatus

DialerDnclistConfigChangeImportStatus importStatus

licenseId

String licenseId

loginId

String loginId

name

String name

size

Integer size

version

Integer version

Class com.mypurecloud.sdk.v2.model.DialerDnclistConfigChangeImportStatus

class DialerDnclistConfigChangeImportStatus extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

completedRecords

Integer completedRecords

failureReason

String failureReason

importState

DialerDnclistConfigChangeImportStatus.ImportStateEnum importState

percentageComplete

Integer percentageComplete

totalRecords

Integer totalRecords

Class com.mypurecloud.sdk.v2.model.DialerDnclistConfigChangeObject

class DialerDnclistConfigChangeObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.DialerDnclistConfigChangeUriReference

class DialerDnclistConfigChangeUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.DialerEventEntityListing

class DialerEventEntityListing extends Object implements Serializable

Serialized Fields

entities

List<EventLog> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DialerOutboundSettingsConfigChangeAtzmTimeSlot

class DialerOutboundSettingsConfigChangeAtzmTimeSlot extends Object implements Serializable

Serialized Fields

earliestCallableTime

String earliestCallableTime

latestCallableTime

String latestCallableTime

Class com.mypurecloud.sdk.v2.model.DialerOutboundSettingsConfigChangeAtzmTimeSlotWithTimeZone

class DialerOutboundSettingsConfigChangeAtzmTimeSlotWithTimeZone extends Object implements Serializable

Serialized Fields

earliestCallableTime

String earliestCallableTime

latestCallableTime

String latestCallableTime

timeZoneId

String timeZoneId

Class com.mypurecloud.sdk.v2.model.DialerOutboundSettingsConfigChangeAutomaticTimeZoneMappingSettings

class DialerOutboundSettingsConfigChangeAutomaticTimeZoneMappingSettings extends Object implements Serializable

Serialized Fields

callableWindows

List<DialerOutboundSettingsConfigChangeCallableWindow> callableWindows

Class com.mypurecloud.sdk.v2.model.DialerOutboundSettingsConfigChangeCallableWindow

class DialerOutboundSettingsConfigChangeCallableWindow extends Object implements Serializable

Serialized Fields

mapped

DialerOutboundSettingsConfigChangeAtzmTimeSlot mapped

unmapped

DialerOutboundSettingsConfigChangeAtzmTimeSlotWithTimeZone unmapped

Class com.mypurecloud.sdk.v2.model.DialerOutboundSettingsConfigChangeOutboundSettings

class DialerOutboundSettingsConfigChangeOutboundSettings extends Object implements Serializable

Serialized Fields

abandonSeconds

BigDecimal abandonSeconds

automaticTimeZoneMapping

DialerOutboundSettingsConfigChangeAutomaticTimeZoneMappingSettings automaticTimeZoneMapping

complianceAbandonRateDenominator

DialerOutboundSettingsConfigChangeOutboundSettings.ComplianceAbandonRateDenominatorEnum complianceAbandonRateDenominator

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

maxCallsPerAgent

Integer maxCallsPerAgent

maxLineUtilization

BigDecimal maxLineUtilization

name

String name

version

Integer version

Class com.mypurecloud.sdk.v2.model.DialerPreview

class DialerPreview extends Object implements Serializable

Serialized Fields

campaignId

String campaignId

contactId

String contactId

contactListId

String contactListId

id

String id

phoneNumberColumns

List<PhoneNumberColumn> phoneNumberColumns

Class com.mypurecloud.sdk.v2.model.DialerResponsesetConfigChangeObject

class DialerResponsesetConfigChangeObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.DialerResponsesetConfigChangeReaction

class DialerResponsesetConfigChangeReaction extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

data

String data

name

String name

reactionType

DialerResponsesetConfigChangeReaction.ReactionTypeEnum reactionType

Class com.mypurecloud.sdk.v2.model.DialerResponsesetConfigChangeResponseSet

class DialerResponsesetConfigChangeResponseSet extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

beepDetectionEnabled

Boolean beepDetectionEnabled

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

name

String name

responses

Map<String,DialerResponsesetConfigChangeReaction> responses

version

Integer version

Class com.mypurecloud.sdk.v2.model.DialerRule

class DialerRule extends Object implements Serializable

Serialized Fields

actions

List<DialerAction> actions

category

DialerRule.CategoryEnum category

conditions

List<Condition> conditions

id

String id

name

String name

order

Integer order

Class com.mypurecloud.sdk.v2.model.DialerRulesetConfigChangeAction

class DialerRulesetConfigChangeAction extends Object implements Serializable

Serialized Fields

actionTypeName

String actionTypeName

additionalProperties

Map<String,Object> additionalProperties

properties

Map<String,String> properties

type

String type

updateOption

String updateOption

Class com.mypurecloud.sdk.v2.model.DialerRulesetConfigChangeCondition

class DialerRulesetConfigChangeCondition extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

agentWrapupField

String agentWrapupField

attributeName

String attributeName

callAnalysisResultField

String callAnalysisResultField

codes

List<String> codes

contactColumnToDataActionFieldMappings

List<DialerRulesetConfigChangeContactColumnToDataActionFieldMapping> contactColumnToDataActionFieldMappings

contactIdField

String contactIdField

dataAction

DialerRulesetConfigChangeUriReference dataAction

dataNotFoundResolution

Boolean dataNotFoundResolution

inverted

Boolean inverted

operator

DialerRulesetConfigChangeCondition.OperatorEnum operator

predicates

List<DialerRulesetConfigChangeDataActionConditionPredicate> predicates

property

String property

propertyType

DialerRulesetConfigChangeCondition.PropertyTypeEnum propertyType

type

String type

value

String value

valueType

DialerRulesetConfigChangeCondition.ValueTypeEnum valueType

Class com.mypurecloud.sdk.v2.model.DialerRulesetConfigChangeContactColumnToDataActionFieldMapping

class DialerRulesetConfigChangeContactColumnToDataActionFieldMapping extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

contactColumnName

String contactColumnName

dataActionField

String dataActionField

Class com.mypurecloud.sdk.v2.model.DialerRulesetConfigChangeDataActionConditionPredicate

class DialerRulesetConfigChangeDataActionConditionPredicate extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

comparisonValue

String comparisonValue

inverted

Boolean inverted

outputField

String outputField

outputFieldMissingResolution

Boolean outputFieldMissingResolution

outputOperator

DialerRulesetConfigChangeDataActionConditionPredicate.OutputOperatorEnum outputOperator

Class com.mypurecloud.sdk.v2.model.DialerRulesetConfigChangeObject

class DialerRulesetConfigChangeObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.DialerRulesetConfigChangeRule

class DialerRulesetConfigChangeRule extends Object implements Serializable

Serialized Fields

actions

List<DialerRulesetConfigChangeAction> actions

additionalProperties

Map<String,Object> additionalProperties

category

DialerRulesetConfigChangeRule.CategoryEnum category

conditions

List<DialerRulesetConfigChangeCondition> conditions

id

String id

name

String name

order

Integer order

Class com.mypurecloud.sdk.v2.model.DialerRulesetConfigChangeRuleSet

class DialerRulesetConfigChangeRuleSet extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

contactList

DialerRulesetConfigChangeUriReference contactList

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

name

String name

queue

DialerRulesetConfigChangeUriReference queue

rules

List<DialerRulesetConfigChangeRule> rules

version

Integer version

Class com.mypurecloud.sdk.v2.model.DialerRulesetConfigChangeUriReference

class DialerRulesetConfigChangeUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.DialerSequenceConfigChangeCampaignSequence

class DialerSequenceConfigChangeCampaignSequence extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

campaigns

List<DialerSequenceConfigChangeUriReference> campaigns

currentCampaign

Integer currentCampaign

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

name

String name

repeat

Boolean repeat

status

DialerSequenceConfigChangeCampaignSequence.StatusEnum status

stopMessage

String stopMessage

version

Integer version

Class com.mypurecloud.sdk.v2.model.DialerSequenceConfigChangeObject

class DialerSequenceConfigChangeObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.DialerSequenceConfigChangeUriReference

class DialerSequenceConfigChangeUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.DialerSequenceScheduleConfigChangeObject

class DialerSequenceScheduleConfigChangeObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.DialerSequenceScheduleConfigChangeScheduleInterval

class DialerSequenceScheduleConfigChangeScheduleInterval extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

end

String end

start

String start

Class com.mypurecloud.sdk.v2.model.DialerSequenceScheduleConfigChangeSequenceSchedule

class DialerSequenceScheduleConfigChangeSequenceSchedule extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

intervals

List<DialerSequenceScheduleConfigChangeScheduleInterval> intervals

name

String name

sequence

DialerSequenceScheduleConfigChangeUriReference sequence

timeZone

String timeZone

version

Integer version

Class com.mypurecloud.sdk.v2.model.DialerSequenceScheduleConfigChangeUriReference

class DialerSequenceScheduleConfigChangeUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.DialerWrapupcodemappingConfigChangeWrapUpCodeMapping

class DialerWrapupcodemappingConfigChangeWrapUpCodeMapping extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

defaultSet

List<DialerWrapupcodemappingConfigChangeWrapUpCodeMapping.DefaultSetEnum> defaultSet

id

String id

mapping

Map<String,List<String>> mapping

name

String name

version

Integer version

Class com.mypurecloud.sdk.v2.model.DialogflowAgent

class DialogflowAgent extends Object implements Serializable

Serialized Fields

environments

List<String> environments

id

String id

integration

DomainEntityRef integration

intents

List<DialogflowIntent> intents

languages

List<String> languages

name

String name

project

DialogflowProject project

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DialogflowAgentSummary

class DialogflowAgentSummary extends Object implements Serializable

Serialized Fields

description

String description

id

String id

integration

DomainEntityRef integration

name

String name

project

DialogflowProject project

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DialogflowAgentSummaryEntityListing

class DialogflowAgentSummaryEntityListing extends Object implements Serializable

Serialized Fields

entities

List<DialogflowAgentSummary> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DialogflowIntent

class DialogflowIntent extends Object implements Serializable

Serialized Fields

name

String name

parameters

Map<String,DialogflowParameter> parameters

Class com.mypurecloud.sdk.v2.model.DialogflowParameter

class DialogflowParameter extends Object implements Serializable

Serialized Fields

name

String name

type

String type

Class com.mypurecloud.sdk.v2.model.DialogflowProject

class DialogflowProject extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.DID

class DID extends Object implements Serializable

Serialized Fields

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

didPool

DomainEntityRef didPool

division

Division division

id

String id

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

owner

DomainEntityRef owner

ownerType

DID.OwnerTypeEnum ownerType

phoneNumber

String phoneNumber

selfUri

String selfUri

state

DID.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.DIDEntityListing

class DIDEntityListing extends Object implements Serializable

Serialized Fields

entities

List<DID> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DIDNumber

class DIDNumber extends Object implements Serializable

Serialized Fields

assigned

Boolean assigned

didPool

AddressableEntityRef didPool

id

String id

name

String name

number

String number

owner

DomainEntityRef owner

ownerType

DIDNumber.OwnerTypeEnum ownerType

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DIDNumberEntityListing

class DIDNumberEntityListing extends Object implements Serializable

Serialized Fields

entities

List<DIDNumber> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DIDPool

class DIDPool extends Object implements Serializable

Serialized Fields

comments

String comments

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

endPhoneNumber

String endPhoneNumber

id

String id

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

provider

DIDPool.ProviderEnum provider

selfUri

String selfUri

startPhoneNumber

String startPhoneNumber

state

DIDPool.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.DIDPoolEntityListing

class DIDPoolEntityListing extends Object implements Serializable

Serialized Fields

entities

List<DIDPool> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DigitalAction

class DigitalAction extends Object implements Serializable

Serialized Fields

appendToDncActionSettings

AppendToDncActionSettings appendToDncActionSettings

doNotSendActionSettings

Object doNotSendActionSettings

markContactAddressUncontactableActionSettings

Object markContactAddressUncontactableActionSettings

markContactUncontactableActionSettings

MarkContactUncontactableActionSettings markContactUncontactableActionSettings

setContentTemplateActionSettings

SetContentTemplateActionSettings setContentTemplateActionSettings

setSmsPhoneNumberActionSettings

SetSmsPhoneNumberActionSettings setSmsPhoneNumberActionSettings

updateContactColumnActionSettings

UpdateContactColumnActionSettings updateContactColumnActionSettings

Class com.mypurecloud.sdk.v2.model.DigitalCondition

class DigitalCondition extends Object implements Serializable

Serialized Fields

contactAddressConditionSettings

ContactAddressConditionSettings contactAddressConditionSettings

contactAddressTypeConditionSettings

ContactAddressTypeConditionSettings contactAddressTypeConditionSettings

contactColumnConditionSettings

ContactColumnConditionSettings contactColumnConditionSettings

dataActionConditionSettings

DataActionConditionSettings dataActionConditionSettings

inverted

Boolean inverted

lastAttemptByColumnConditionSettings

LastAttemptByColumnConditionSettings lastAttemptByColumnConditionSettings

lastAttemptOverallConditionSettings

LastAttemptOverallConditionSettings lastAttemptOverallConditionSettings

lastResultByColumnConditionSettings

LastResultByColumnConditionSettings lastResultByColumnConditionSettings

lastResultOverallConditionSettings

LastResultOverallConditionSettings lastResultOverallConditionSettings

Class com.mypurecloud.sdk.v2.model.DigitalDataActionConditionPredicate

class DigitalDataActionConditionPredicate extends Object implements Serializable

Serialized Fields

comparisonValue

String comparisonValue

inverted

Boolean inverted

outputField

String outputField

outputFieldMissingResolution

Boolean outputFieldMissingResolution

outputOperator

DigitalDataActionConditionPredicate.OutputOperatorEnum outputOperator

Class com.mypurecloud.sdk.v2.model.DigitalRule

class DigitalRule extends Object implements Serializable

Serialized Fields

actions

List<DigitalAction> actions

category

DigitalRule.CategoryEnum category

conditions

List<DigitalCondition> conditions

id

String id

name

String name

order

Integer order

Class com.mypurecloud.sdk.v2.model.DigitalRuleSet

class DigitalRuleSet extends Object implements Serializable

Serialized Fields

contactList

DomainEntityRef contactList

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

name

String name

rules

List<DigitalRule> rules

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.DigitalRuleSetEntityListing

class DigitalRuleSetEntityListing extends Object implements Serializable

Serialized Fields

entities

List<DigitalRuleSet> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DigitLength

class DigitLength extends Object implements Serializable

Serialized Fields

end

String end

start

String start

Class com.mypurecloud.sdk.v2.model.Digits

class Digits extends Object implements Serializable

Serialized Fields

digits

String digits

Class com.mypurecloud.sdk.v2.model.DirectoryUserDevicesListing

class DirectoryUserDevicesListing extends Object implements Serializable

Serialized Fields

entities

List<UserDevice> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DirectRouting

class DirectRouting extends Object implements Serializable

Serialized Fields

agentWaitSeconds

Integer agentWaitSeconds

backupQueueId

String backupQueueId

callMediaSettings

DirectRoutingCallMediaSettings callMediaSettings

emailMediaSettings

DirectRoutingMediaSettings emailMediaSettings

messageMediaSettings

DirectRoutingMediaSettings messageMediaSettings

waitForAgent

Boolean waitForAgent

Class com.mypurecloud.sdk.v2.model.DirectRoutingCallMediaSettings

class DirectRoutingCallMediaSettings extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

inboundFlow

AddressableEntityRef inboundFlow

voicemailFlow

AddressableEntityRef voicemailFlow

Class com.mypurecloud.sdk.v2.model.DirectRoutingMediaSettings

class DirectRoutingMediaSettings extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

inboundFlow

AddressableEntityRef inboundFlow

Class com.mypurecloud.sdk.v2.model.DisallowedEntityLearningAssignmentItem

class DisallowedEntityLearningAssignmentItem extends Object implements Serializable

Serialized Fields

entity

LearningAssignmentItem entity

errorCode

String errorCode

Class com.mypurecloud.sdk.v2.model.DisallowedEntityLearningAssignmentReference

class DisallowedEntityLearningAssignmentReference extends Object implements Serializable

Serialized Fields

entity

LearningAssignmentReference entity

errorCode

String errorCode

Class com.mypurecloud.sdk.v2.model.DisconnectReason

class DisconnectReason extends Object implements Serializable

Serialized Fields

code

Integer code

phrase

String phrase

type

DisconnectReason.TypeEnum type

Class com.mypurecloud.sdk.v2.model.Disposition

class Disposition extends Object implements Serializable

Serialized Fields

analyzer

String analyzer

dispositionParameters

DispositionParameters dispositionParameters

name

String name

Class com.mypurecloud.sdk.v2.model.DispositionParameters

class DispositionParameters extends Object implements Serializable

Serialized Fields

adjustableLiveSpeakerDetection

AdjustableLiveSpeakerDetection adjustableLiveSpeakerDetection

Class com.mypurecloud.sdk.v2.model.Division

class Division extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DivisionReference

class DivisionReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DivsPermittedEntityListing

class DivsPermittedEntityListing extends Object implements Serializable

Serialized Fields

allDivsPermitted

Boolean allDivsPermitted

entities

List<AuthzDivision> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DncList

class DncList extends Object implements Serializable

Serialized Fields

campaignId

String campaignId

contactMethod

DncList.ContactMethodEnum contactMethod

customExclusionColumn

String customExclusionColumn

dateCreated

Date dateCreated

dateModified

Date dateModified

division

DomainEntityRef division

dncCodes

List<String> dncCodes

dncSourceType

DncList.DncSourceTypeEnum dncSourceType

id

String id

importStatus

ImportStatus importStatus

licenseId

String licenseId

loginId

String loginId

name

String name

selfUri

String selfUri

size

Long size

version

Integer version

Class com.mypurecloud.sdk.v2.model.DncListCreate

class DncListCreate extends Object implements Serializable

Serialized Fields

campaignId

String campaignId

contactMethod

DncListCreate.ContactMethodEnum contactMethod

customExclusionColumn

String customExclusionColumn

dateCreated

Date dateCreated

dateModified

Date dateModified

division

DomainEntityRef division

dncCodes

List<String> dncCodes

dncSourceType

DncListCreate.DncSourceTypeEnum dncSourceType

id

String id

importStatus

ImportStatus importStatus

licenseId

String licenseId

loginId

String loginId

name

String name

selfUri

String selfUri

size

Long size

version

Integer version

Class com.mypurecloud.sdk.v2.model.DncListDivisionView

class DncListDivisionView extends Object implements Serializable

Serialized Fields

contactMethod

DncListDivisionView.ContactMethodEnum contactMethod

division

Division division

dncSourceType

DncListDivisionView.DncSourceTypeEnum dncSourceType

id

String id

importStatus

ImportStatus importStatus

name

String name

selfUri

String selfUri

size

Long size

Class com.mypurecloud.sdk.v2.model.DncListDivisionViewListing

class DncListDivisionViewListing extends Object implements Serializable

Serialized Fields

entities

List<DncListDivisionView> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DnclistDownloadReadyExportUri

class DnclistDownloadReadyExportUri extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

exportTimestamp

String exportTimestamp

uri

String uri

Class com.mypurecloud.sdk.v2.model.DnclistDownloadReadyObject

class DnclistDownloadReadyObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.DncListEntityListing

class DncListEntityListing extends Object implements Serializable

Serialized Fields

entities

List<DncList> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DnclistImportStatusImportStatus

class DnclistImportStatusImportStatus extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

completedRecords

Integer completedRecords

failureReason

String failureReason

importState

DnclistImportStatusImportStatus.ImportStateEnum importState

percentageComplete

Integer percentageComplete

totalRecords

Integer totalRecords

Class com.mypurecloud.sdk.v2.model.DnclistImportStatusObject

class DnclistImportStatusObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.DncPatchCustomExclusionColumnsRequest

class DncPatchCustomExclusionColumnsRequest extends Object implements Serializable

Serialized Fields

action

DncPatchCustomExclusionColumnsRequest.ActionEnum action

customExclusionColumnEntries

List<String> customExclusionColumnEntries

expirationDateTime

String expirationDateTime

Class com.mypurecloud.sdk.v2.model.DncPatchEmailsRequest

class DncPatchEmailsRequest extends Object implements Serializable

Serialized Fields

action

DncPatchEmailsRequest.ActionEnum action

emailAddresses

List<String> emailAddresses

expirationDateTime

String expirationDateTime

Class com.mypurecloud.sdk.v2.model.DncPatchPhoneNumbersRequest

class DncPatchPhoneNumbersRequest extends Object implements Serializable

Serialized Fields

action

DncPatchPhoneNumbersRequest.ActionEnum action

expirationDateTime

String expirationDateTime

phoneNumbers

List<String> phoneNumbers

Class com.mypurecloud.sdk.v2.model.DnsRecordEntry

class DnsRecordEntry extends Object implements Serializable

Serialized Fields

host

String host

recordContents

String recordContents

verificationStatus

DnsRecordEntry.VerificationStatusEnum verificationStatus

Class com.mypurecloud.sdk.v2.model.Document

class Document extends Object implements Serializable

Serialized Fields

acl

List<String> acl

attributes

List<DocumentAttribute> attributes

callerAddress

String callerAddress

changeNumber

Integer changeNumber

contentLength

Long contentLength

contentType

String contentType

contentUri

String contentUri

createdBy

DomainEntityRef createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

dateUploaded

Date dateUploaded

downloadSharingUri

String downloadSharingUri

filename

String filename

id

String id

lockInfo

LockInfo lockInfo

name

String name

pageCount

Long pageCount

read

Boolean read

receiverAddress

String receiverAddress

selfUri

String selfUri

sharingStatus

Document.SharingStatusEnum sharingStatus

sharingUri

String sharingUri

systemType

Document.SystemTypeEnum systemType

tags

List<String> tags

tagValues

List<TagValue> tagValues

thumbnails

List<DocumentThumbnail> thumbnails

uploadDestinationUri

String uploadDestinationUri

uploadedBy

DomainEntityRef uploadedBy

uploadMethod

Document.UploadMethodEnum uploadMethod

uploadStatus

DomainEntityRef uploadStatus

workspace

DomainEntityRef workspace

Class com.mypurecloud.sdk.v2.model.DocumentArticle

class DocumentArticle extends Object implements Serializable

Serialized Fields

alternatives

List<String> alternatives

content

ArticleContent content

title

String title

Class com.mypurecloud.sdk.v2.model.DocumentationResult

class DocumentationResult extends Object implements Serializable

Serialized Fields

categories

List<Integer> categories

content

String content

description

String description

excerpt

String excerpt

facetFeature

List<Integer> facetFeature

facetRole

List<Integer> facetRole

facetService

List<Integer> facetService

faqCategories

List<Integer> faqCategories

getType

String getType

id

Integer id

link

String link

modified

Date modified

name

String name

releasenoteCategory

List<Integer> releasenoteCategory

releasenoteTag

List<Integer> releasenoteTag

service

List<Integer> service

serviceArea

List<Integer> serviceArea

slug

String slug

title

String title

videoCategories

List<Integer> videoCategories

Class com.mypurecloud.sdk.v2.model.DocumentationSearchCriteria

class DocumentationSearchCriteria extends Object implements Serializable

Serialized Fields

dateFormat

String dateFormat

endValue

String endValue

fields

List<String> fields

group

List<DocumentationSearchCriteria> group

operator

DocumentationSearchCriteria.OperatorEnum operator

startValue

String startValue

type

DocumentationSearchCriteria.TypeEnum type

value

String value

values

List<String> values

Class com.mypurecloud.sdk.v2.model.DocumentationSearchRequest

class DocumentationSearchRequest extends Object implements Serializable

Serialized Fields

pageNumber

Integer pageNumber

pageSize

Integer pageSize

query

List<DocumentationSearchCriteria> query

sort

List<SearchSort> sort

sortBy

String sortBy

sortOrder

DocumentationSearchRequest.SortOrderEnum sortOrder

Class com.mypurecloud.sdk.v2.model.DocumentationSearchResponse

class DocumentationSearchResponse extends Object implements Serializable

Serialized Fields

currentPage

String currentPage

nextPage

String nextPage

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousPage

String previousPage

results

List<DocumentationResult> results

total

Long total

types

List<String> types

Class com.mypurecloud.sdk.v2.model.DocumentationV2SearchAggregation

class DocumentationV2SearchAggregation extends Object implements Serializable

Serialized Fields

field

String field

name

String name

order

List<DocumentationV2SearchAggregation.OrderEnum> order

size

Integer size

type

DocumentationV2SearchAggregation.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.DocumentationV2SearchCriteria

class DocumentationV2SearchCriteria extends Object implements Serializable

Serialized Fields

dateFormat

String dateFormat

endValue

String endValue

fields

List<String> fields

group

List<DocumentationV2SearchCriteria> group

operator

DocumentationV2SearchCriteria.OperatorEnum operator

startValue

String startValue

type

DocumentationV2SearchCriteria.TypeEnum type

value

String value

values

List<String> values

Class com.mypurecloud.sdk.v2.model.DocumentationV2SearchRequest

class DocumentationV2SearchRequest extends Object implements Serializable

Serialized Fields

aggregations

List<DocumentationV2SearchAggregation> aggregations

pageNumber

Integer pageNumber

pageSize

Integer pageSize

query

List<DocumentationV2SearchCriteria> query

sort

List<SearchSort> sort

sortBy

String sortBy

sortOrder

DocumentationV2SearchRequest.SortOrderEnum sortOrder

types

List<String> types

Class com.mypurecloud.sdk.v2.model.DocumentAttribute

class DocumentAttribute extends Object implements Serializable

Serialized Fields

attribute

Attribute attribute

values

List<String> values

Class com.mypurecloud.sdk.v2.model.DocumentAudit

class DocumentAudit extends Object implements Serializable

Serialized Fields

action

DocumentAudit.ActionEnum action

actionContext

DocumentAudit.ActionContextEnum actionContext

application

String application

changes

List<AuditChange> changes

entity

AuditEntityReference entity

id

String id

level

DocumentAudit.LevelEnum level

name

String name

selfUri

String selfUri

serviceName

String serviceName

status

DocumentAudit.StatusEnum status

timestamp

Date timestamp

transactionId

String transactionId

transactionInitiator

Boolean transactionInitiator

user

DomainEntityRef user

workspace

DomainEntityRef workspace

Class com.mypurecloud.sdk.v2.model.DocumentAuditEntityListing

class DocumentAuditEntityListing extends Object implements Serializable

Serialized Fields

entities

List<DocumentAudit> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DocumentBody

class DocumentBody extends Object implements Serializable

Serialized Fields

blocks

List<DocumentBodyBlock> blocks

Class com.mypurecloud.sdk.v2.model.DocumentBodyBlock

class DocumentBodyBlock extends Object implements Serializable

Serialized Fields

image

DocumentBodyImage image

list

DocumentBodyList list

paragraph

DocumentBodyParagraph paragraph

type

DocumentBodyBlock.TypeEnum type

video

DocumentBodyVideo video

Class com.mypurecloud.sdk.v2.model.DocumentBodyImage

class DocumentBodyImage extends Object implements Serializable

Serialized Fields

hyperlink

String hyperlink

properties

DocumentBodyImageProperties properties

url

String url

Class com.mypurecloud.sdk.v2.model.DocumentBodyImageProperties

class DocumentBodyImageProperties extends Object implements Serializable

Serialized Fields

align

DocumentBodyImageProperties.AlignEnum align

backgroundColor

String backgroundColor

indentation

Float indentation

Class com.mypurecloud.sdk.v2.model.DocumentBodyList

class DocumentBodyList extends Object implements Serializable

Serialized Fields

blocks

List<DocumentBodyListBlock> blocks

properties

DocumentBodyListBlockProperties properties

Class com.mypurecloud.sdk.v2.model.DocumentBodyListBlock

class DocumentBodyListBlock extends Object implements Serializable

Serialized Fields

blocks

List<DocumentListContentBlock> blocks

properties

DocumentBodyListItemProperties properties

type

DocumentBodyListBlock.TypeEnum type

Class com.mypurecloud.sdk.v2.model.DocumentBodyListBlockProperties

class DocumentBodyListBlockProperties extends Object implements Serializable

Serialized Fields

orderedType

DocumentBodyListBlockProperties.OrderedTypeEnum orderedType

unorderedType

DocumentBodyListBlockProperties.UnorderedTypeEnum unorderedType

Class com.mypurecloud.sdk.v2.model.DocumentBodyListItemProperties

class DocumentBodyListItemProperties extends Object implements Serializable

Serialized Fields

align

DocumentBodyListItemProperties.AlignEnum align

backgroundColor

String backgroundColor

fontSize

DocumentBodyListItemProperties.FontSizeEnum fontSize

fontType

DocumentBodyListItemProperties.FontTypeEnum fontType

indentation

Float indentation

textColor

String textColor

Class com.mypurecloud.sdk.v2.model.DocumentBodyParagraph

class DocumentBodyParagraph extends Object implements Serializable

Serialized Fields

blocks

List<DocumentContentBlock> blocks

properties

DocumentBodyParagraphProperties properties

Class com.mypurecloud.sdk.v2.model.DocumentBodyParagraphProperties

class DocumentBodyParagraphProperties extends Object implements Serializable

Serialized Fields

align

DocumentBodyParagraphProperties.AlignEnum align

backgroundColor

String backgroundColor

fontSize

DocumentBodyParagraphProperties.FontSizeEnum fontSize

fontType

DocumentBodyParagraphProperties.FontTypeEnum fontType

indentation

Float indentation

textColor

String textColor

Class com.mypurecloud.sdk.v2.model.DocumentBodyVideo

class DocumentBodyVideo extends Object implements Serializable

Serialized Fields

properties

DocumentBodyVideoProperties properties

url

String url

Class com.mypurecloud.sdk.v2.model.DocumentBodyVideoProperties

class DocumentBodyVideoProperties extends Object implements Serializable

Serialized Fields

align

DocumentBodyVideoProperties.AlignEnum align

backgroundColor

String backgroundColor

indentation

Float indentation

Class com.mypurecloud.sdk.v2.model.DocumentCategoryInput

class DocumentCategoryInput extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.DocumentContentBlock

class DocumentContentBlock extends Object implements Serializable

Serialized Fields

image

DocumentBodyImage image

text

DocumentText text

type

DocumentContentBlock.TypeEnum type

Class com.mypurecloud.sdk.v2.model.DocumentEntityListing

class DocumentEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Document> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DocumentFaq

class DocumentFaq extends Object implements Serializable

Serialized Fields

alternatives

List<String> alternatives

answer

String answer

question

String question

Class com.mypurecloud.sdk.v2.model.DocumentListContentBlock

class DocumentListContentBlock extends Object implements Serializable

Serialized Fields

image

DocumentBodyImage image

list

DocumentBodyList list

text

DocumentText text

type

DocumentListContentBlock.TypeEnum type

Class com.mypurecloud.sdk.v2.model.DocumentListing

class DocumentListing extends Object implements Serializable

Serialized Fields

entities

List<KnowledgeDocument> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DocumentQuery

class DocumentQuery extends Object implements Serializable

Serialized Fields

clauses

List<DocumentQueryClause> clauses

operator

DocumentQuery.OperatorEnum operator

Class com.mypurecloud.sdk.v2.model.DocumentQueryClause

class DocumentQueryClause extends Object implements Serializable

Serialized Fields

operator

DocumentQueryClause.OperatorEnum operator

predicates

List<DocumentQueryPredicate> predicates

Class com.mypurecloud.sdk.v2.model.DocumentQueryInterval

class DocumentQueryInterval extends Object implements Serializable

Serialized Fields

field

DocumentQueryInterval.FieldEnum field

value

String value

Class com.mypurecloud.sdk.v2.model.DocumentQueryPredicate

class DocumentQueryPredicate extends Object implements Serializable

Serialized Fields

fields

List<DocumentQueryPredicate.FieldsEnum> fields

type

DocumentQueryPredicate.TypeEnum type

values

List<String> values

Class com.mypurecloud.sdk.v2.model.DocumentReference

class DocumentReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DocumentText

class DocumentText extends Object implements Serializable

Serialized Fields

hyperlink

String hyperlink

marks

List<DocumentText.MarksEnum> marks

properties

DocumentTextProperties properties

text

String text

Class com.mypurecloud.sdk.v2.model.DocumentTextProperties

class DocumentTextProperties extends Object implements Serializable

Serialized Fields

backgroundColor

String backgroundColor

fontSize

DocumentTextProperties.FontSizeEnum fontSize

textColor

String textColor

Class com.mypurecloud.sdk.v2.model.DocumentThumbnail

class DocumentThumbnail extends Object implements Serializable

Serialized Fields

height

Integer height

imageUri

String imageUri

resolution

String resolution

width

Integer width

Class com.mypurecloud.sdk.v2.model.DocumentUpdate

class DocumentUpdate extends Object implements Serializable

Serialized Fields

addTagIds

List<String> addTagIds

addTags

List<String> addTags

changeNumber

Integer changeNumber

name

String name

read

Boolean read

removeAttributes

List<String> removeAttributes

removeTagIds

List<String> removeTagIds

removeTags

List<String> removeTags

updateAttributes

List<DocumentAttribute> updateAttributes

Class com.mypurecloud.sdk.v2.model.DocumentUpload

class DocumentUpload extends Object implements Serializable

Serialized Fields

name

String name

tagIds

List<String> tagIds

tags

List<String> tags

workspace

DomainEntityRef workspace

Class com.mypurecloud.sdk.v2.model.DocumentVariation

class DocumentVariation extends Object implements Serializable

Serialized Fields

body

DocumentBody body

contexts

List<DocumentVariationContext> contexts

dateCreated

Date dateCreated

dateModified

Date dateModified

document

KnowledgeDocumentReference document

documentVersion

AddressableEntityRef documentVersion

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DocumentVariationContext

class DocumentVariationContext extends Object implements Serializable

Serialized Fields

context

KnowledgeContextReference context

values

List<KnowledgeContextValueReference> values

Class com.mypurecloud.sdk.v2.model.DocumentVariationListing

class DocumentVariationListing extends Object implements Serializable

Serialized Fields

entities

List<DocumentVariation> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DomainCapabilities

class DomainCapabilities extends Object implements Serializable

Serialized Fields

autoMetric

Boolean autoMetric

dhcp

Boolean dhcp

enabled

Boolean enabled

metric

Integer metric

pingEnabled

Boolean pingEnabled

supportsMetric

Boolean supportsMetric

Class com.mypurecloud.sdk.v2.model.DomainCertificateAuthority

class DomainCertificateAuthority extends Object implements Serializable

Serialized Fields

certificate

String certificate

certificateDetails

List<CertificateDetails> certificateDetails

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

id

String id

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

selfUri

String selfUri

services

List<DomainCertificateAuthority.ServicesEnum> services

state

DomainCertificateAuthority.StateEnum state

type

DomainCertificateAuthority.TypeEnum type

version

Integer version

Class com.mypurecloud.sdk.v2.model.DomainEdgeSoftwareUpdateDto

class DomainEdgeSoftwareUpdateDto extends Object implements Serializable

Serialized Fields

callDrainingWaitTimeSeconds

Long callDrainingWaitTimeSeconds

current

Boolean current

downloadStartTime

Date downloadStartTime

edgeUri

String edgeUri

executeOnIdle

Boolean executeOnIdle

executeStartTime

Date executeStartTime

executeStopTime

Date executeStopTime

maxDownloadRate

Integer maxDownloadRate

status

DomainEdgeSoftwareUpdateDto.StatusEnum status

version

DomainEdgeSoftwareVersionDto version

Class com.mypurecloud.sdk.v2.model.DomainEdgeSoftwareVersionDto

class DomainEdgeSoftwareVersionDto extends Object implements Serializable

Serialized Fields

current

Boolean current

edgeUri

String edgeUri

edgeVersion

String edgeVersion

id

String id

latestRelease

Boolean latestRelease

name

String name

publishDate

Date publishDate

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DomainEdgeSoftwareVersionDtoEntityListing

class DomainEdgeSoftwareVersionDtoEntityListing extends Object implements Serializable

Serialized Fields

entities

List<DomainEdgeSoftwareVersionDto> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DomainEntity

class DomainEntity extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DomainEntityListing

class DomainEntityListing extends Object implements Serializable

Serialized Fields

entities

List<DomainEntity> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DomainEntityListingEvaluationForm

class DomainEntityListingEvaluationForm extends Object implements Serializable

Serialized Fields

entities

List<EvaluationForm> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DomainEntityListingQueryResult

class DomainEntityListingQueryResult extends Object implements Serializable

Serialized Fields

entities

List<QueryResult> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DomainEntityListingSurveyForm

class DomainEntityListingSurveyForm extends Object implements Serializable

Serialized Fields

entities

List<SurveyForm> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.DomainEntityRef

class DomainEntityRef extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DomainLogicalInterface

class DomainLogicalInterface extends Object implements Serializable

Serialized Fields

addresses

List<DomainNetworkAddress> addresses

commandResponses

List<DomainNetworkCommandResponse> commandResponses

createdBy

String createdBy

createdByApp

String createdByApp

currentState

DomainLogicalInterface.CurrentStateEnum currentState

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

edgeAssignedId

String edgeAssignedId

edgeUri

String edgeUri

endDate

Date endDate

externalTrunkBaseAssignments

List<TrunkBaseAssignment> externalTrunkBaseAssignments

friendlyName

String friendlyName

hardwareAddress

String hardwareAddress

id

String id

ifStatus

String ifStatus

inheritPhoneTrunkBasesIPv4

Boolean inheritPhoneTrunkBasesIPv4

inheritPhoneTrunkBasesIPv6

Boolean inheritPhoneTrunkBasesIPv6

interfaceType

DomainLogicalInterface.InterfaceTypeEnum interfaceType

ipv4Capabilities

DomainCapabilities ipv4Capabilities

ipv6Capabilities

DomainCapabilities ipv6Capabilities

lastModifiedCorrelationId

String lastModifiedCorrelationId

lastModifiedUserId

String lastModifiedUserId

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

phoneTrunkBaseAssignments

List<TrunkBaseAssignment> phoneTrunkBaseAssignments

physicalAdapterId

String physicalAdapterId

publicNatAddressIpV4

String publicNatAddressIpV4

publicNatAddressIpV6

String publicNatAddressIpV6

routes

List<DomainNetworkRoute> routes

selfUri

String selfUri

startDate

Date startDate

state

DomainLogicalInterface.StateEnum state

traceEnabled

Boolean traceEnabled

useForCloudProxyEdgeCommunication

Boolean useForCloudProxyEdgeCommunication

useForIndirectEdgeCommunication

Boolean useForIndirectEdgeCommunication

useForInternalEdgeCommunication

Boolean useForInternalEdgeCommunication

useForWanInterface

Boolean useForWanInterface

version

Integer version

vlanTagId

Integer vlanTagId

Class com.mypurecloud.sdk.v2.model.DomainNetworkAddress

class DomainNetworkAddress extends Object implements Serializable

Serialized Fields

address

String address

family

DomainNetworkAddress.FamilyEnum family

persistent

Boolean persistent

type

DomainNetworkAddress.TypeEnum type

Class com.mypurecloud.sdk.v2.model.DomainNetworkCommandResponse

class DomainNetworkCommandResponse extends Object implements Serializable

Serialized Fields

acknowledged

Boolean acknowledged

commandName

String commandName

correlationId

String correlationId

errorInfo

ErrorDetails errorInfo

Class com.mypurecloud.sdk.v2.model.DomainNetworkRoute

class DomainNetworkRoute extends Object implements Serializable

Serialized Fields

family

DomainNetworkRoute.FamilyEnum family

metric

Integer metric

nexthop

String nexthop

persistent

Boolean persistent

prefix

String prefix

Class com.mypurecloud.sdk.v2.model.DomainOrganizationProduct

class DomainOrganizationProduct extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.DomainOrganizationRole

class DomainOrganizationRole extends Object implements Serializable

Serialized Fields

_default

Boolean _default

base

Boolean base

defaultRoleId

String defaultRoleId

description

String description

id

String id

name

String name

permissionPolicies

List<DomainPermissionPolicy> permissionPolicies

permissions

List<String> permissions

roleNeedsUpdate

Boolean roleNeedsUpdate

selfUri

String selfUri

unusedPermissions

List<String> unusedPermissions

userCount

Integer userCount

Class com.mypurecloud.sdk.v2.model.DomainOrganizationRoleCreate

class DomainOrganizationRoleCreate extends Object implements Serializable

Serialized Fields

_default

Boolean _default

base

Boolean base

defaultRoleId

String defaultRoleId

description

String description

id

String id

name

String name

permissionPolicies

List<DomainPermissionPolicy> permissionPolicies

permissions

List<String> permissions

roleNeedsUpdate

Boolean roleNeedsUpdate

selfUri

String selfUri

unusedPermissions

List<String> unusedPermissions

userCount

Integer userCount

Class com.mypurecloud.sdk.v2.model.DomainOrganizationRoleUpdate

class DomainOrganizationRoleUpdate extends Object implements Serializable

Serialized Fields

_default

Boolean _default

base

Boolean base

defaultRoleId

String defaultRoleId

description

String description

id

String id

name

String name

permissionPolicies

List<DomainPermissionPolicy> permissionPolicies

permissions

List<String> permissions

roleNeedsUpdate

Boolean roleNeedsUpdate

selfUri

String selfUri

unusedPermissions

List<String> unusedPermissions

userCount

Integer userCount

Class com.mypurecloud.sdk.v2.model.DomainOrgRoleDifference

class DomainOrgRoleDifference extends Object implements Serializable

Serialized Fields

addedPermissionPolicies

List<DomainPermissionPolicy> addedPermissionPolicies

removedPermissionPolicies

List<DomainPermissionPolicy> removedPermissionPolicies

roleFromDefault

DomainOrganizationRole roleFromDefault

samePermissionPolicies

List<DomainPermissionPolicy> samePermissionPolicies

userOrgRole

DomainOrganizationRole userOrgRole

Class com.mypurecloud.sdk.v2.model.DomainPermission

class DomainPermission extends Object implements Serializable

Serialized Fields

action

String action

allowsConditions

Boolean allowsConditions

divisionAware

Boolean divisionAware

domain

String domain

entityType

String entityType

label

String label

Class com.mypurecloud.sdk.v2.model.DomainPermissionCollection

class DomainPermissionCollection extends Object implements Serializable

Serialized Fields

domain

String domain

id

String id

name

String name

permissionMap

Map<String,List<DomainPermission>> permissionMap

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DomainPermissionPolicy

class DomainPermissionPolicy extends Object implements Serializable

Serialized Fields

actionSet

List<String> actionSet

allowConditions

Boolean allowConditions

domain

String domain

entityName

String entityName

namedResources

List<String> namedResources

policyDescription

String policyDescription

policyName

String policyName

resourceConditionNode

DomainResourceConditionNode resourceConditionNode

Class com.mypurecloud.sdk.v2.model.DomainPhysicalCapabilities

class DomainPhysicalCapabilities extends Object implements Serializable

Serialized Fields

team

Boolean team

vlan

Boolean vlan

Class com.mypurecloud.sdk.v2.model.DomainPhysicalInterface

class DomainPhysicalInterface extends Object implements Serializable

Serialized Fields

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

edgeUri

String edgeUri

friendlyName

String friendlyName

hardwareAddress

String hardwareAddress

id

String id

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

physicalCapabilities

DomainPhysicalCapabilities physicalCapabilities

portLabel

String portLabel

selfUri

String selfUri

state

DomainPhysicalInterface.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.DomainResourceConditionNode

class DomainResourceConditionNode extends Object implements Serializable

Serialized Fields

conjunction

DomainResourceConditionNode.ConjunctionEnum conjunction

operands

List<DomainResourceConditionValue> operands

operator

DomainResourceConditionNode.OperatorEnum operator

terms

List<DomainResourceConditionNode> terms

variableName

String variableName

Class com.mypurecloud.sdk.v2.model.DomainResourceConditionValue

class DomainResourceConditionValue extends Object implements Serializable

Serialized Fields

queue

Queue queue

type

DomainResourceConditionValue.TypeEnum type

user

User user

value

String value

Class com.mypurecloud.sdk.v2.model.DomainRole

class DomainRole extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.DoNotSendActionSettings

class DoNotSendActionSettings extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.DownloadResponse

class DownloadResponse extends Object implements Serializable

Serialized Fields

contentLocationUri

String contentLocationUri

imageUri

String imageUri

thumbnails

List<DocumentThumbnail> thumbnails

Class com.mypurecloud.sdk.v2.model.Draft

class Draft extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

intents

List<DraftIntents> intents

miner

Miner miner

name

String name

selfUri

String selfUri

topics

List<DraftTopics> topics

Class com.mypurecloud.sdk.v2.model.DraftIntents

class DraftIntents extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

utterances

List<String> utterances

Class com.mypurecloud.sdk.v2.model.DraftListing

class DraftListing extends Object implements Serializable

Serialized Fields

entities

List<Draft> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DraftManipulationRequest

class DraftManipulationRequest extends Object implements Serializable

Serialized Fields

draftType

DraftManipulationRequest.DraftTypeEnum draftType

translate

HistoryHeadersTranslation translate

Class com.mypurecloud.sdk.v2.model.DraftRequest

class DraftRequest extends Object implements Serializable

Serialized Fields

intents

List<DraftIntents> intents

topics

List<DraftTopicRequest> topics

Class com.mypurecloud.sdk.v2.model.DraftTopicRequest

class DraftTopicRequest extends Object implements Serializable

Serialized Fields

id

String id

name

String name

phrases

List<String> phrases

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DraftTopics

class DraftTopics extends Object implements Serializable

Serialized Fields

conversationCount

Integer conversationCount

conversationPercent

Float conversationPercent

id

String id

miner

Miner miner

name

String name

phraseCount

Integer phraseCount

phrases

List<String> phrases

selfUri

String selfUri

utteranceCount

Integer utteranceCount

Class com.mypurecloud.sdk.v2.model.DraftValidationResult

class DraftValidationResult extends Object implements Serializable

Serialized Fields

errors

List<ErrorBody> errors

valid

Boolean valid

Class com.mypurecloud.sdk.v2.model.DurationCondition

class DurationCondition extends Object implements Serializable

Serialized Fields

durationMode

DurationCondition.DurationModeEnum durationMode

durationOperator

String durationOperator

durationRange

String durationRange

durationTarget

DurationCondition.DurationTargetEnum durationTarget

Class com.mypurecloud.sdk.v2.model.DynamicContactQueueingSettings

class DynamicContactQueueingSettings extends Object implements Serializable

Serialized Fields

sort

Boolean sort

Class com.mypurecloud.sdk.v2.model.DynamicGroupDefinition

class DynamicGroupDefinition extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

group

AddressableEntityRef group

query

DynamicGroupQuery query

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.DynamicGroupLanguageSkillCondition

class DynamicGroupLanguageSkillCondition extends Object implements Serializable

Serialized Fields

childConditions

List<DynamicGroupSkillCondition> childConditions

comparator

DynamicGroupLanguageSkillCondition.ComparatorEnum comparator

languageSkill

String languageSkill

proficiency

Integer proficiency

Class com.mypurecloud.sdk.v2.model.DynamicGroupQuery

class DynamicGroupQuery extends Object implements Serializable

Serialized Fields

skillConditions

List<DynamicGroupSkillCondition> skillConditions

Class com.mypurecloud.sdk.v2.model.DynamicGroupQueryPreview

class DynamicGroupQueryPreview extends Object implements Serializable

Serialized Fields

userCount

Integer userCount

Class com.mypurecloud.sdk.v2.model.DynamicGroupRoutingSkillCondition

class DynamicGroupRoutingSkillCondition extends Object implements Serializable

Serialized Fields

childConditions

List<DynamicGroupSkillCondition> childConditions

comparator

DynamicGroupRoutingSkillCondition.ComparatorEnum comparator

proficiency

Integer proficiency

routingSkill

String routingSkill

Class com.mypurecloud.sdk.v2.model.DynamicGroupSkillCondition

class DynamicGroupSkillCondition extends Object implements Serializable

Serialized Fields

languageSkillConditions

List<DynamicGroupLanguageSkillCondition> languageSkillConditions

operation

DynamicGroupSkillCondition.OperationEnum operation

routingSkillConditions

List<DynamicGroupRoutingSkillCondition> routingSkillConditions

Class com.mypurecloud.sdk.v2.model.Edge

class Edge extends Object implements Serializable

Serialized Fields

apiVersion

String apiVersion

callDrainingState

Edge.CallDrainingStateEnum callDrainingState

conversationCount

Integer conversationCount

createdBy

String createdBy

createdByApp

String createdByApp

currentVersion

String currentVersion

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

edgeDeploymentType

Edge.EdgeDeploymentTypeEnum edgeDeploymentType

edgeGroup

EdgeGroup edgeGroup

fingerprint

String fingerprint

fingerprintHint

String fingerprintHint

fullSoftwareVersion

String fullSoftwareVersion

id

String id

interfaces

List<EdgeInterface> interfaces

make

String make

managed

Boolean managed

model

String model

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

offlineConfigCalled

Boolean offlineConfigCalled

onlineStatus

Edge.OnlineStatusEnum onlineStatus

osName

String osName

pairingId

String pairingId

patch

String patch

physicalEdge

Boolean physicalEdge

proxy

String proxy

selfUri

String selfUri

serialNumber

String serialNumber

site

Site site

softwareStatus

DomainEdgeSoftwareUpdateDto softwareStatus

softwareVersion

String softwareVersion

softwareVersionConfiguration

String softwareVersionConfiguration

softwareVersionPlatform

String softwareVersionPlatform

softwareVersionTimestamp

String softwareVersionTimestamp

stagedVersion

String stagedVersion

state

Edge.StateEnum state

statusCode

Edge.StatusCodeEnum statusCode

version

Integer version

Class com.mypurecloud.sdk.v2.model.EdgeAutoUpdateConfig

class EdgeAutoUpdateConfig extends Object implements Serializable

Serialized Fields

end

org.joda.time.LocalDateTime end

rrule

String rrule

start

org.joda.time.LocalDateTime start

timeZone

String timeZone

Class com.mypurecloud.sdk.v2.model.EdgeChangeTopicEdge

class EdgeChangeTopicEdge extends Object implements Serializable

Serialized Fields

id

String id

onlineStatus

EdgeChangeTopicEdge.OnlineStatusEnum onlineStatus

Class com.mypurecloud.sdk.v2.model.EdgeConnectionInfo

class EdgeConnectionInfo extends Object implements Serializable

Serialized Fields

connectionErrors

List<String> connectionErrors

id

String id

interfaceIpAddress

String interfaceIpAddress

interfaceName

String interfaceName

name

String name

selfUri

String selfUri

site

AddressableEntityRef site

Class com.mypurecloud.sdk.v2.model.EdgeEntityListing

class EdgeEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Edge> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.EdgeGroup

class EdgeGroup extends Object implements Serializable

Serialized Fields

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

edgeTrunkBaseAssignment

TrunkBaseAssignment edgeTrunkBaseAssignment

hybrid

Boolean hybrid

id

String id

managed

Boolean managed

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

phoneTrunkBases

List<TrunkBase> phoneTrunkBases

selfUri

String selfUri

state

EdgeGroup.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.EdgeGroupEntityListing

class EdgeGroupEntityListing extends Object implements Serializable

Serialized Fields

entities

List<EdgeGroup> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.EdgeInterface

class EdgeInterface extends Object implements Serializable

Serialized Fields

addressFamilyId

String addressFamilyId

endpoints

List<DomainEntityRef> endpoints

ifName

String ifName

ipAddress

String ipAddress

lineTypes

List<EdgeInterface.LineTypesEnum> lineTypes

macAddress

String macAddress

name

String name

type

String type

Class com.mypurecloud.sdk.v2.model.EdgeLogicalInterfacesChangeTopicDomainLogicalInterfaceChange

class EdgeLogicalInterfacesChangeTopicDomainLogicalInterfaceChange extends Object implements Serializable

Serialized Fields

errorInfo

EdgeLogicalInterfacesChangeTopicErrorInfo errorInfo

id

String id

Class com.mypurecloud.sdk.v2.model.EdgeLogicalInterfacesChangeTopicErrorInfo

class EdgeLogicalInterfacesChangeTopicErrorInfo extends Object implements Serializable

Serialized Fields

code

String code

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

Class com.mypurecloud.sdk.v2.model.EdgeLogsJob

class EdgeLogsJob extends Object implements Serializable

Serialized Fields

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

files

List<EdgeLogsJobFile> files

id

String id

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

selfUri

String selfUri

state

EdgeLogsJob.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.EdgeLogsJobFile

class EdgeLogsJobFile extends Object implements Serializable

Serialized Fields

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

downloadId

String downloadId

edgePath

String edgePath

id

String id

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

selfUri

String selfUri

sizeBytes

Double sizeBytes

state

EdgeLogsJobFile.StateEnum state

timeCreated

Date timeCreated

timeModified

Date timeModified

uploadStatus

EdgeLogsJobFile.UploadStatusEnum uploadStatus

version

Integer version

Class com.mypurecloud.sdk.v2.model.EdgeLogsJobRequest

class EdgeLogsJobRequest extends Object implements Serializable

Serialized Fields

path

String path

query

String query

recurse

Boolean recurse

Class com.mypurecloud.sdk.v2.model.EdgeLogsJobResponse

class EdgeLogsJobResponse extends Object implements Serializable

Serialized Fields

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

id

String id

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

selfUri

String selfUri

state

EdgeLogsJobResponse.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.EdgeLogsJobUploadRequest

class EdgeLogsJobUploadRequest extends Object implements Serializable

Serialized Fields

fileIds

List<String> fileIds

Class com.mypurecloud.sdk.v2.model.EdgeMetrics

class EdgeMetrics extends Object implements Serializable

Serialized Fields

disks

List<EdgeMetricsDisk> disks

edge

DomainEntityRef edge

eventTime

Date eventTime

memory

List<EdgeMetricsMemory> memory

networks

List<EdgeMetricsNetwork> networks

processors

List<EdgeMetricsProcessor> processors

subsystems

List<EdgeMetricsSubsystem> subsystems

upTimeMsec

Long upTimeMsec

Class com.mypurecloud.sdk.v2.model.EdgeMetricsDisk

class EdgeMetricsDisk extends Object implements Serializable

Serialized Fields

availableBytes

Double availableBytes

partitionName

String partitionName

totalBytes

Double totalBytes

Class com.mypurecloud.sdk.v2.model.EdgeMetricsMemory

class EdgeMetricsMemory extends Object implements Serializable

Serialized Fields

availableBytes

Double availableBytes

totalBytes

Double totalBytes

type

String type

Class com.mypurecloud.sdk.v2.model.EdgeMetricsNetwork

class EdgeMetricsNetwork extends Object implements Serializable

Serialized Fields

bandwidthBitsPerSec

Double bandwidthBitsPerSec

ifname

String ifname

receivedBytesPerSec

Integer receivedBytesPerSec

sentBytesPerSec

Integer sentBytesPerSec

utilizationPct

Double utilizationPct

Class com.mypurecloud.sdk.v2.model.EdgeMetricsProcessor

class EdgeMetricsProcessor extends Object implements Serializable

Serialized Fields

activeTimePct

Double activeTimePct

cpuId

String cpuId

idleTimePct

Double idleTimePct

privilegedTimePct

Double privilegedTimePct

userTimePct

Double userTimePct

Class com.mypurecloud.sdk.v2.model.EdgeMetricsSubsystem

class EdgeMetricsSubsystem extends Object implements Serializable

Serialized Fields

delayMs

Integer delayMs

mediaSubsystem

EdgeMetricsSubsystem mediaSubsystem

processName

String processName

Class com.mypurecloud.sdk.v2.model.EdgeMetricsTopicEdgeMetricDisk

class EdgeMetricsTopicEdgeMetricDisk extends Object implements Serializable

Serialized Fields

availableBytes

Integer availableBytes

partitionName

String partitionName

totalBytes

Integer totalBytes

Class com.mypurecloud.sdk.v2.model.EdgeMetricsTopicEdgeMetricMemory

class EdgeMetricsTopicEdgeMetricMemory extends Object implements Serializable

Serialized Fields

availableBytes

Integer availableBytes

totalBytes

Integer totalBytes

type

String type

Class com.mypurecloud.sdk.v2.model.EdgeMetricsTopicEdgeMetricNetworks

class EdgeMetricsTopicEdgeMetricNetworks extends Object implements Serializable

Serialized Fields

bandwidthBitsPerSec

Integer bandwidthBitsPerSec

ifname

String ifname

receivedBytesPerSec

Integer receivedBytesPerSec

sentBytesPerSec

Integer sentBytesPerSec

utilizationPct

BigDecimal utilizationPct

Class com.mypurecloud.sdk.v2.model.EdgeMetricsTopicEdgeMetricProcessor

class EdgeMetricsTopicEdgeMetricProcessor extends Object implements Serializable

Serialized Fields

activeTimePct

Integer activeTimePct

cpuId

String cpuId

idleTimePct

Integer idleTimePct

privilegedTimePct

Integer privilegedTimePct

userTimePct

Integer userTimePct

Class com.mypurecloud.sdk.v2.model.EdgeMetricsTopicEdgeMetrics

class EdgeMetricsTopicEdgeMetrics extends Object implements Serializable

Serialized Fields

disks

List<EdgeMetricsTopicEdgeMetricDisk> disks

edge

EdgeMetricsTopicUriReference edge

eventTime

Date eventTime

memory

List<EdgeMetricsTopicEdgeMetricMemory> memory

networks

List<EdgeMetricsTopicEdgeMetricNetworks> networks

processors

List<EdgeMetricsTopicEdgeMetricProcessor> processors

subsystems

List<EdgeMetricsTopicEdgeMetricSubsystem> subsystems

upTimeMsec

Integer upTimeMsec

Class com.mypurecloud.sdk.v2.model.EdgeMetricsTopicEdgeMetricSubsystem

class EdgeMetricsTopicEdgeMetricSubsystem extends Object implements Serializable

Serialized Fields

delayMs

Integer delayMs

mediaSubsystem

EdgeMetricsTopicEdgeMetricSubsystemMedia mediaSubsystem

processName

String processName

Class com.mypurecloud.sdk.v2.model.EdgeMetricsTopicEdgeMetricSubsystemMedia

class EdgeMetricsTopicEdgeMetricSubsystemMedia extends Object implements Serializable

Serialized Fields

delayMs

Integer delayMs

processName

String processName

Class com.mypurecloud.sdk.v2.model.EdgeMetricsTopicUriReference

class EdgeMetricsTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.EdgeNetworkDiagnostic

class EdgeNetworkDiagnostic extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.EdgeNetworkDiagnosticRequest

class EdgeNetworkDiagnosticRequest extends Object implements Serializable

Serialized Fields

host

String host

Class com.mypurecloud.sdk.v2.model.EdgeNetworkDiagnosticResponse

class EdgeNetworkDiagnosticResponse extends Object implements Serializable

Serialized Fields

commandCorrelationId

String commandCorrelationId

diagnostics

String diagnostics

Class com.mypurecloud.sdk.v2.model.EdgeRebootParameters

class EdgeRebootParameters extends Object implements Serializable

Serialized Fields

callDrainingWaitTimeSeconds

Integer callDrainingWaitTimeSeconds

Class com.mypurecloud.sdk.v2.model.EdgeServiceStateRequest

class EdgeServiceStateRequest extends Object implements Serializable

Serialized Fields

callDrainingWaitTimeSeconds

Integer callDrainingWaitTimeSeconds

inService

Boolean inService

Class com.mypurecloud.sdk.v2.model.EdgeSoftwareUpdateTopicDomainEdgeSoftwareUpdate

class EdgeSoftwareUpdateTopicDomainEdgeSoftwareUpdate extends Object implements Serializable

Serialized Fields

downloadStartTime

Date downloadStartTime

executeStartTime

Date executeStartTime

executeStopTime

Date executeStopTime

id

String id

status

EdgeSoftwareUpdateTopicDomainEdgeSoftwareUpdate.StatusEnum status

Class com.mypurecloud.sdk.v2.model.EdgeTrunkBase

class EdgeTrunkBase extends Object implements Serializable

Serialized Fields

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

id

String id

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

properties

Map<String,Object> properties

selfUri

String selfUri

state

EdgeTrunkBase.StateEnum state

trunkMetabase

DomainEntityRef trunkMetabase

trunkType

EdgeTrunkBase.TrunkTypeEnum trunkType

version

Integer version

Class com.mypurecloud.sdk.v2.model.EdgeVersionInformation

class EdgeVersionInformation extends Object implements Serializable

Serialized Fields

softwareVersion

String softwareVersion

Class com.mypurecloud.sdk.v2.model.EdgeVersionReport

class EdgeVersionReport extends Object implements Serializable

Serialized Fields

newestVersion

EdgeVersionInformation newestVersion

oldestVersion

EdgeVersionInformation oldestVersion

Class com.mypurecloud.sdk.v2.model.Education

class Education extends Object implements Serializable

Serialized Fields

dateEnd

LocalDate dateEnd

dateStart

LocalDate dateStart

fieldOfStudy

String fieldOfStudy

notes

String notes

school

String school

Class com.mypurecloud.sdk.v2.model.EffectiveConfiguration

class EffectiveConfiguration extends Object implements Serializable

Serialized Fields

advanced

Map<String,Object> advanced

credentials

Map<String,CredentialInfo> credentials

name

String name

notes

String notes

properties

Map<String,Object> properties

Class com.mypurecloud.sdk.v2.model.Email

class Email extends Object implements Serializable

Serialized Fields

afterCallWork

AfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

autoGenerated

Boolean autoGenerated

connectedTime

Date connectedTime

direction

Email.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectType

Email.DisconnectTypeEnum disconnectType

draftAttachments

List<Attachment> draftAttachments

errorInfo

ErrorBody errorInfo

held

Boolean held

id

String id

initialState

Email.InitialStateEnum initialState

messageId

String messageId

messagesSent

Integer messagesSent

peerId

String peerId

provider

String provider

recordingId

String recordingId

scriptId

String scriptId

segments

List<Segment> segments

spam

Boolean spam

startAlertingTime

Date startAlertingTime

startHoldTime

Date startHoldTime

state

Email.StateEnum state

subject

String subject

wrapup

Wrapup wrapup

Class com.mypurecloud.sdk.v2.model.EmailAddress

class EmailAddress extends Object implements Serializable

Serialized Fields

email

String email

name

String name

Class com.mypurecloud.sdk.v2.model.EmailAttachment

class EmailAttachment extends Object implements Serializable

Serialized Fields

attachmentId

String attachmentId

contentLength

Integer contentLength

contentPath

String contentPath

contentType

String contentType

name

String name

Class com.mypurecloud.sdk.v2.model.EmailCampaignSchedule

class EmailCampaignSchedule extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

emailCampaign

DomainEntityRef emailCampaign

id

String id

intervals

List<ScheduleInterval> intervals

name

String name

selfUri

String selfUri

timeZone

String timeZone

version

Integer version

Class com.mypurecloud.sdk.v2.model.EmailColumn

class EmailColumn extends Object implements Serializable

Serialized Fields

columnName

String columnName

contactableTimeColumn

String contactableTimeColumn

type

String type

Class com.mypurecloud.sdk.v2.model.EmailConfig

class EmailConfig extends Object implements Serializable

Serialized Fields

contentTemplate

DomainEntityRef contentTemplate

emailColumns

List<String> emailColumns

fromAddress

FromEmailAddress fromAddress

replyToAddress

ReplyToEmailAddress replyToAddress

Class com.mypurecloud.sdk.v2.model.EmailConversation

class EmailConversation extends Object implements Serializable

Serialized Fields

id

String id

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<EmailMediaParticipant> participants

recentTransfers

List<TransferResponse> recentTransfers

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.EmailConversationEntityListing

class EmailConversationEntityListing extends Object implements Serializable

Serialized Fields

entities

List<EmailConversation> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.EmailMediaParticipant

class EmailMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

autoGenerated

Boolean autoGenerated

connectedTime

Date connectedTime

conversationRoutingData

ConversationRoutingData conversationRoutingData

direction

EmailMediaParticipant.DirectionEnum direction

disconnectType

EmailMediaParticipant.DisconnectTypeEnum disconnectType

draftAttachments

List<Attachment> draftAttachments

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

ErrorInfo errorInfo

externalContact

DomainEntityRef externalContact

externalOrganization

DomainEntityRef externalOrganization

flaggedReason

EmailMediaParticipant.FlaggedReasonEnum flaggedReason

held

Boolean held

id

String id

journeyContext

JourneyContext journeyContext

mediaRoles

List<String> mediaRoles

messageId

String messageId

messagesSent

Integer messagesSent

name

String name

peer

String peer

provider

String provider

purpose

String purpose

queue

DomainEntityRef queue

script

DomainEntityRef script

spam

Boolean spam

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

EmailMediaParticipant.StateEnum state

subject

String subject

team

DomainEntityRef team

user

DomainEntityRef user

wrapup

Wrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.EmailMediaPolicy

class EmailMediaPolicy extends Object implements Serializable

Serialized Fields

actions

PolicyActions actions

conditions

EmailMediaPolicyConditions conditions

Class com.mypurecloud.sdk.v2.model.EmailMediaPolicyConditions

class EmailMediaPolicyConditions extends Object implements Serializable

Serialized Fields

customerParticipation

EmailMediaPolicyConditions.CustomerParticipationEnum customerParticipation

dateRanges

List<String> dateRanges

forQueues

List<Queue> forQueues

forUsers

List<User> forUsers

languages

List<Language> languages

timeAllowed

TimeAllowed timeAllowed

wrapupCodes

List<WrapupCode> wrapupCodes

Class com.mypurecloud.sdk.v2.model.EmailMessage

class EmailMessage extends Object implements Serializable

Serialized Fields

attachments

List<Attachment> attachments

bcc

List<EmailAddress> bcc

cc

List<EmailAddress> cc

draftType

EmailMessage.DraftTypeEnum draftType

emailSizeBytes

Integer emailSizeBytes

from

EmailAddress from

historyIncluded

Boolean historyIncluded

htmlBody

String htmlBody

id

String id

maxEmailSizeBytes

Integer maxEmailSizeBytes

name

String name

replyTo

EmailAddress replyTo

selfUri

String selfUri

state

EmailMessage.StateEnum state

subject

String subject

textBody

String textBody

time

Date time

to

List<EmailAddress> to

Class com.mypurecloud.sdk.v2.model.EmailMessageListing

class EmailMessageListing extends Object implements Serializable

Serialized Fields

entities

List<EmailMessage> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.EmailMessageReply

class EmailMessageReply extends Object implements Serializable

Serialized Fields

attachments

List<Attachment> attachments

bcc

List<EmailAddress> bcc

cc

List<EmailAddress> cc

emailSizeBytes

Integer emailSizeBytes

from

EmailAddress from

historyIncluded

Boolean historyIncluded

htmlBody

String htmlBody

maxEmailSizeBytes

Integer maxEmailSizeBytes

replyTo

EmailAddress replyTo

subject

String subject

textBody

String textBody

time

Date time

to

List<EmailAddress> to

Class com.mypurecloud.sdk.v2.model.EmailOutboundDomainResult

class EmailOutboundDomainResult extends Object implements Serializable

Serialized Fields

dnsCnameBounceRecord

DnsRecordEntry dnsCnameBounceRecord

dnsTxtSendingRecord

DnsRecordEntry dnsTxtSendingRecord

domainName

String domainName

senderStatus

EmailOutboundDomainResult.SenderStatusEnum senderStatus

senderType

EmailOutboundDomainResult.SenderTypeEnum senderType

Class com.mypurecloud.sdk.v2.model.EmailSetup

class EmailSetup extends Object implements Serializable

Serialized Fields

rootDomain

String rootDomain

Class com.mypurecloud.sdk.v2.model.EmailsSettings

class EmailsSettings extends Object implements Serializable

Serialized Fields

sendingSizeLimit

Integer sendingSizeLimit

Class com.mypurecloud.sdk.v2.model.EmbeddedIntegration

class EmbeddedIntegration extends Object implements Serializable

Serialized Fields

domainWhitelist

List<String> domainWhitelist

enableWhitelist

Boolean enableWhitelist

Class com.mypurecloud.sdk.v2.model.EmergencyCallFlow

class EmergencyCallFlow extends Object implements Serializable

Serialized Fields

emergencyFlow

DomainEntityRef emergencyFlow

ivrs

List<DomainEntityRef> ivrs

Class com.mypurecloud.sdk.v2.model.EmergencyGroup

class EmergencyGroup extends Object implements Serializable

Serialized Fields

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

WritableDivision division

emergencyCallFlows

List<EmergencyCallFlow> emergencyCallFlows

enabled

Boolean enabled

id

String id

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

selfUri

String selfUri

state

EmergencyGroup.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.EmergencyGroupListing

class EmergencyGroupListing extends Object implements Serializable

Serialized Fields

entities

List<EmergencyGroup> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.EmergencyLocation

class EmergencyLocation extends Object implements Serializable

Serialized Fields

address

LocationAddress address

did

String did

id

String id

name

String name

selfUri

String selfUri

source

EmergencyLocation.SourceEnum source

Class com.mypurecloud.sdk.v2.model.EmployerInfo

class EmployerInfo extends Object implements Serializable

Serialized Fields

dateHire

String dateHire

employeeId

String employeeId

employeeType

String employeeType

officialName

String officialName

Class com.mypurecloud.sdk.v2.model.Empty

class Empty extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.EncryptionKey

class EncryptionKey extends Object implements Serializable

Serialized Fields

createDate

Date createDate

id

String id

keyConfigurationType

EncryptionKey.KeyConfigurationTypeEnum keyConfigurationType

keydataSummary

String keydataSummary

kmsKeyArn

String kmsKeyArn

localEncryptionConfiguration

LocalEncryptionConfiguration localEncryptionConfiguration

name

String name

selfUri

String selfUri

user

User user

Class com.mypurecloud.sdk.v2.model.EncryptionKeyEntityListing

class EncryptionKeyEntityListing extends Object implements Serializable

Serialized Fields

entities

List<EncryptionKey> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.EndConsultTransferEvent

class EndConsultTransferEvent extends Object implements Serializable

Serialized Fields

conversationId

String conversationId

eventDateTime

Date eventDateTime

eventId

String eventId

Class com.mypurecloud.sdk.v2.model.Endpoint

class Endpoint extends Object implements Serializable

Serialized Fields

count

Integer count

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

dids

List<String> dids

division

Division division

enabled

Boolean enabled

id

String id

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

properties

Map<String,Object> properties

schema

DomainEntityRef schema

selfUri

String selfUri

site

DomainEntityRef site

state

Endpoint.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.EndTransferEvent

class EndTransferEvent extends Object implements Serializable

Serialized Fields

commandId

String commandId

conversationId

String conversationId

eventDateTime

Date eventDateTime

eventId

String eventId

finalState

EndTransferEvent.FinalStateEnum finalState

objectCommunicationId

String objectCommunicationId

Class com.mypurecloud.sdk.v2.model.Entity

class Entity extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.EntityChange

class EntityChange extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

entityType

String entityType

newValues

List<String> newValues

oldValues

List<String> oldValues

Class com.mypurecloud.sdk.v2.model.EntityListing

class EntityListing extends Object implements Serializable

Serialized Fields

entities

List<Object> entities

Class com.mypurecloud.sdk.v2.model.EntityTypeCriteria

class EntityTypeCriteria extends Object implements Serializable

Serialized Fields

entityType

EntityTypeCriteria.EntityTypeEnum entityType

key

String key

operator

EntityTypeCriteria.OperatorEnum operator

shouldIgnoreCase

Boolean shouldIgnoreCase

values

List<String> values

Class com.mypurecloud.sdk.v2.model.Entry

class Entry extends Object implements Serializable

Serialized Fields

count

Integer count

value

String value

Class com.mypurecloud.sdk.v2.model.ErrorBody

class ErrorBody extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

details

List<Detail> details

entityId

String entityId

entityName

String entityName

errors

List<ErrorBody> errors

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.ErrorDetails

class ErrorDetails extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

details

String details

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

nested

ErrorDetails nested

status

Integer status

Class com.mypurecloud.sdk.v2.model.ErrorInfo

class ErrorInfo extends Object implements Serializable

Serialized Fields

code

String code

message

String message

Class com.mypurecloud.sdk.v2.model.EstimatedWaitTimePredictions

class EstimatedWaitTimePredictions extends Object implements Serializable

Serialized Fields

results

List<PredictionResults> results

Class com.mypurecloud.sdk.v2.model.EstimateJobAsyncResponse

class EstimateJobAsyncResponse extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.Evaluation

class Evaluation extends Object implements Serializable

Serialized Fields

agent

User agent

agentHasRead

Boolean agentHasRead

answers

EvaluationScoringSet answers

assigned

Boolean assigned

assignedDate

Date assignedDate

assignee

User assignee

authorizedActions

List<String> authorizedActions

calibration

Calibration calibration

changedDate

Date changedDate

conversation

ConversationReference conversation

conversationDate

Date conversationDate

conversationEndDate

Date conversationEndDate

dateAssigneeChanged

Date dateAssigneeChanged

evaluationForm

EvaluationForm evaluationForm

evaluationSource

EvaluationSource evaluationSource

evaluator

User evaluator

hasAssistanceFailed

Boolean hasAssistanceFailed

id

String id

isScoringIndex

Boolean isScoringIndex

mediaType

List<Evaluation.MediaTypeEnum> mediaType

name

String name

neverRelease

Boolean neverRelease

queue

Queue queue

redacted

Boolean redacted

releaseDate

Date releaseDate

rescore

Boolean rescore

resourceId

String resourceId

resourceType

Evaluation.ResourceTypeEnum resourceType

selfUri

String selfUri

status

Evaluation.StatusEnum status

Class com.mypurecloud.sdk.v2.model.EvaluationAggregateDataContainer

class EvaluationAggregateDataContainer extends Object implements Serializable

Serialized Fields

data

List<StatisticalResponse> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.EvaluationAggregateQueryClause

class EvaluationAggregateQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<EvaluationAggregateQueryPredicate> predicates

type

EvaluationAggregateQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.EvaluationAggregateQueryFilter

class EvaluationAggregateQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<EvaluationAggregateQueryClause> clauses

predicates

List<EvaluationAggregateQueryPredicate> predicates

type

EvaluationAggregateQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.EvaluationAggregateQueryPredicate

class EvaluationAggregateQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

EvaluationAggregateQueryPredicate.DimensionEnum dimension

operator

EvaluationAggregateQueryPredicate.OperatorEnum operator

range

NumericRange range

type

EvaluationAggregateQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.EvaluationAggregateQueryResponse

class EvaluationAggregateQueryResponse extends Object implements Serializable

Serialized Fields

results

List<EvaluationAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.EvaluationAggregationQuery

class EvaluationAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

EvaluationAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

EvaluationAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<EvaluationAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<EvaluationAggregationQuery.MetricsEnum> metrics

timeZone

String timeZone

views

List<EvaluationAggregationView> views

Class com.mypurecloud.sdk.v2.model.EvaluationAggregationQueryMe

class EvaluationAggregationQueryMe extends Object implements Serializable

Serialized Fields

alternateTimeDimension

EvaluationAggregationQueryMe.AlternateTimeDimensionEnum alternateTimeDimension

contextId

String contextId

groupBy

List<EvaluationAggregationQueryMe.GroupByEnum> groupBy

interval

String interval

metrics

List<EvaluationAggregationQueryMe.MetricsEnum> metrics

timeZone

String timeZone

Class com.mypurecloud.sdk.v2.model.EvaluationAggregationView

class EvaluationAggregationView extends Object implements Serializable

Serialized Fields

function

EvaluationAggregationView.FunctionEnum function

name

String name

range

AggregationRange range

target

EvaluationAggregationView.TargetEnum target

Class com.mypurecloud.sdk.v2.model.EvaluationAssignment

class EvaluationAssignment extends Object implements Serializable

Serialized Fields

evaluationForm

EvaluationForm evaluationForm

user

User user

Class com.mypurecloud.sdk.v2.model.EvaluationAsyncAggregateQueryResponse

class EvaluationAsyncAggregateQueryResponse extends Object implements Serializable

Serialized Fields

cursor

String cursor

results

List<EvaluationAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.EvaluationAsyncAggregationQuery

class EvaluationAsyncAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

EvaluationAsyncAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

EvaluationAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<EvaluationAsyncAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<EvaluationAsyncAggregationQuery.MetricsEnum> metrics

pageSize

Integer pageSize

timeZone

String timeZone

views

List<EvaluationAggregationView> views

Class com.mypurecloud.sdk.v2.model.EvaluationDetailQueryClause

class EvaluationDetailQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<EvaluationDetailQueryPredicate> predicates

type

EvaluationDetailQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.EvaluationDetailQueryFilter

class EvaluationDetailQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<EvaluationDetailQueryClause> clauses

predicates

List<EvaluationDetailQueryPredicate> predicates

type

EvaluationDetailQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.EvaluationDetailQueryPredicate

class EvaluationDetailQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

EvaluationDetailQueryPredicate.DimensionEnum dimension

metric

EvaluationDetailQueryPredicate.MetricEnum metric

operator

EvaluationDetailQueryPredicate.OperatorEnum operator

range

NumericRange range

type

EvaluationDetailQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.EvaluationEntityListing

class EvaluationEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Evaluation> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.EvaluationForm

class EvaluationForm extends Object implements Serializable

Serialized Fields

contextId

String contextId

id

String id

modifiedDate

Date modifiedDate

name

String name

published

Boolean published

publishedVersions

DomainEntityListingEvaluationForm publishedVersions

questionGroups

List<EvaluationQuestionGroup> questionGroups

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.EvaluationFormAndScoringSet

class EvaluationFormAndScoringSet extends Object implements Serializable

Serialized Fields

answers

EvaluationScoringSet answers

evaluationForm

EvaluationForm evaluationForm

Class com.mypurecloud.sdk.v2.model.EvaluationFormEntityListing

class EvaluationFormEntityListing extends Object implements Serializable

Serialized Fields

entities

List<EvaluationForm> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.EvaluationFormResponse

class EvaluationFormResponse extends Object implements Serializable

Serialized Fields

contextId

String contextId

id

String id

modifiedDate

Date modifiedDate

name

String name

published

Boolean published

publishedVersions

DomainEntityListingEvaluationForm publishedVersions

questionGroups

List<EvaluationQuestionGroup> questionGroups

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.EvaluationQualityV2TopicCalibration

class EvaluationQualityV2TopicCalibration extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.EvaluationQualityV2TopicEvaluationReference

class EvaluationQualityV2TopicEvaluationReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.EvaluationQualityV2TopicEvaluationScoringSet

class EvaluationQualityV2TopicEvaluationScoringSet extends Object implements Serializable

Serialized Fields

totalCriticalScore

Integer totalCriticalScore

totalScore

Integer totalScore

Class com.mypurecloud.sdk.v2.model.EvaluationQualityV2TopicEvaluationSource

class EvaluationQualityV2TopicEvaluationSource extends Object implements Serializable

Serialized Fields

evaluationSourceId

String evaluationSourceId

evaluationSourceName

String evaluationSourceName

evaluationSourceType

String evaluationSourceType

Class com.mypurecloud.sdk.v2.model.EvaluationQualityV2TopicEvaluationV2

class EvaluationQualityV2TopicEvaluationV2 extends Object implements Serializable

Serialized Fields

agent

EvaluationQualityV2TopicUser agent

agentCommentHasUpdated

Boolean agentCommentHasUpdated

agentHasRead

Boolean agentHasRead

assignedDate

Date assignedDate

assigneeUserId

String assigneeUserId

calibration

EvaluationQualityV2TopicCalibration calibration

changedDate

Date changedDate

contextId

String contextId

conversationDate

Date conversationDate

conversationId

String conversationId

declinedReview

Boolean declinedReview

disputeCount

Integer disputeCount

divisionIds

List<String> divisionIds

evaluationContextId

String evaluationContextId

evaluationFormId

String evaluationFormId

evaluationSource

EvaluationQualityV2TopicEvaluationSource evaluationSource

evaluator

EvaluationQualityV2TopicUser evaluator

evaluatorCommentHasUpdated

Boolean evaluatorCommentHasUpdated

eventTime

Date eventTime

eventType

String eventType

formName

String formName

id

String id

mediaType

List<String> mediaType

previousAssigneeUserId

String previousAssigneeUserId

previousStatus

EvaluationQualityV2TopicEvaluationV2.PreviousStatusEnum previousStatus

releaseDate

Date releaseDate

rescore

Boolean rescore

rescoreCount

Integer rescoreCount

resourceId

String resourceId

resourceType

String resourceType

retractedEvaluation

EvaluationQualityV2TopicEvaluationReference retractedEvaluation

scoringSet

EvaluationQualityV2TopicEvaluationScoringSet scoringSet

status

EvaluationQualityV2TopicEvaluationV2.StatusEnum status

version

Integer version

Class com.mypurecloud.sdk.v2.model.EvaluationQualityV2TopicUser

class EvaluationQualityV2TopicUser extends Object implements Serializable

Serialized Fields

displayName

String displayName

id

String id

Class com.mypurecloud.sdk.v2.model.EvaluationQuestion

class EvaluationQuestion extends Object implements Serializable

Serialized Fields

answerOptions

List<AnswerOption> answerOptions

commentsRequired

Boolean commentsRequired

helpText

String helpText

id

String id

isCritical

Boolean isCritical

isKill

Boolean isKill

naEnabled

Boolean naEnabled

text

String text

type

EvaluationQuestion.TypeEnum type

visibilityCondition

VisibilityCondition visibilityCondition

Class com.mypurecloud.sdk.v2.model.EvaluationQuestionGroup

class EvaluationQuestionGroup extends Object implements Serializable

Serialized Fields

defaultAnswersToHighest

Boolean defaultAnswersToHighest

defaultAnswersToNA

Boolean defaultAnswersToNA

id

String id

manualWeight

Boolean manualWeight

naEnabled

Boolean naEnabled

name

String name

questions

List<EvaluationQuestion> questions

type

String type

visibilityCondition

VisibilityCondition visibilityCondition

weight

Float weight

Class com.mypurecloud.sdk.v2.model.EvaluationQuestionGroupScore

class EvaluationQuestionGroupScore extends Object implements Serializable

Serialized Fields

markedNA

Boolean markedNA

maxTotalCriticalScore

Float maxTotalCriticalScore

maxTotalCriticalScoreUnweighted

Float maxTotalCriticalScoreUnweighted

maxTotalNonCriticalScore

Float maxTotalNonCriticalScore

maxTotalNonCriticalScoreUnweighted

Float maxTotalNonCriticalScoreUnweighted

maxTotalScore

Float maxTotalScore

maxTotalScoreUnweighted

Float maxTotalScoreUnweighted

questionGroupId

String questionGroupId

questionScores

List<EvaluationQuestionScore> questionScores

totalCriticalScore

Float totalCriticalScore

totalCriticalScoreUnweighted

Float totalCriticalScoreUnweighted

totalNonCriticalScore

Float totalNonCriticalScore

totalNonCriticalScoreUnweighted

Float totalNonCriticalScoreUnweighted

totalScore

Float totalScore

totalScoreUnweighted

Float totalScoreUnweighted

Class com.mypurecloud.sdk.v2.model.EvaluationQuestionScore

class EvaluationQuestionScore extends Object implements Serializable

Serialized Fields

answerId

String answerId

assistedAnswerId

String assistedAnswerId

comments

String comments

failedKillQuestion

Boolean failedKillQuestion

markedNA

Boolean markedNA

questionId

String questionId

score

Integer score

Class com.mypurecloud.sdk.v2.model.EvaluationReference

class EvaluationReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.EvaluationResponse

class EvaluationResponse extends Object implements Serializable

Serialized Fields

agent

User agent

agentHasRead

Boolean agentHasRead

answers

EvaluationScoringSet answers

assigned

Boolean assigned

assignedDate

Date assignedDate

assignee

User assignee

authorizedActions

List<String> authorizedActions

calibration

Calibration calibration

changedDate

Date changedDate

conversation

ConversationReference conversation

conversationDate

Date conversationDate

conversationEndDate

Date conversationEndDate

dateAssigneeChanged

Date dateAssigneeChanged

evaluationForm

EvaluationFormResponse evaluationForm

evaluationSource

EvaluationSource evaluationSource

evaluator

User evaluator

hasAssistanceFailed

Boolean hasAssistanceFailed

id

String id

isScoringIndex

Boolean isScoringIndex

mediaType

List<EvaluationResponse.MediaTypeEnum> mediaType

name

String name

neverRelease

Boolean neverRelease

queue

Queue queue

redacted

Boolean redacted

releaseDate

Date releaseDate

rescore

Boolean rescore

resourceId

String resourceId

resourceType

EvaluationResponse.ResourceTypeEnum resourceType

selfUri

String selfUri

status

EvaluationResponse.StatusEnum status

Class com.mypurecloud.sdk.v2.model.EvaluationScoringSet

class EvaluationScoringSet extends Object implements Serializable

Serialized Fields

agentComments

String agentComments

anyFailedKillQuestions

Boolean anyFailedKillQuestions

comments

String comments

privateComments

String privateComments

questionGroupScores

List<EvaluationQuestionGroupScore> questionGroupScores

totalCriticalScore

Float totalCriticalScore

totalNonCriticalScore

Float totalNonCriticalScore

totalScore

Float totalScore

transcriptTopics

List<TranscriptTopic> transcriptTopics

Class com.mypurecloud.sdk.v2.model.EvaluationSettings

class EvaluationSettings extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.EvaluationSettingsAssignee

class EvaluationSettingsAssignee extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.EvaluationSource

class EvaluationSource extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

type

EvaluationSource.TypeEnum type

Class com.mypurecloud.sdk.v2.model.EvaluationVersion

class EvaluationVersion extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.EvaluatorActivity

class EvaluatorActivity extends Object implements Serializable

Serialized Fields

evaluator

User evaluator

id

String id

name

String name

numCalibrationsAssigned

Integer numCalibrationsAssigned

numCalibrationsCompleted

Integer numCalibrationsCompleted

numCalibrationsStarted

Integer numCalibrationsStarted

numEvaluationsAssigned

Integer numEvaluationsAssigned

numEvaluationsCompleted

Integer numEvaluationsCompleted

numEvaluationsStarted

Integer numEvaluationsStarted

numEvaluationsWithoutViewPermission

Integer numEvaluationsWithoutViewPermission

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.EvaluatorActivityEntityListing

class EvaluatorActivityEntityListing extends Object implements Serializable

Serialized Fields

entities

List<EvaluatorActivity> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.Event

class Event extends Object implements Serializable

Serialized Fields

correlationId

String correlationId

createdDate

Date createdDate

customerId

String customerId

customerIdType

String customerIdType

eventType

String eventType

genericActionEvent

GenericActionEvent genericActionEvent

id

String id

outcomeAchievedEvent

OutcomeAchievedEvent outcomeAchievedEvent

segmentAssignedEvent

SegmentAssignedEvent segmentAssignedEvent

segmentAssignmentEvent

SegmentAssignmentEvent segmentAssignmentEvent

session

EventSession session

webActionEvent

WebActionEvent webActionEvent

webEvent

WebEvent webEvent

Class com.mypurecloud.sdk.v2.model.EventAction

class EventAction extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

id

String id

mediaType

EventAction.MediaTypeEnum mediaType

prompt

String prompt

state

EventAction.StateEnum state

Class com.mypurecloud.sdk.v2.model.EventCoBrowse

class EventCoBrowse extends Object implements Serializable

Serialized Fields

sessionId

String sessionId

sessionJoinToken

String sessionJoinToken

type

EventCoBrowse.TypeEnum type

Class com.mypurecloud.sdk.v2.model.EventCondition

class EventCondition extends Object implements Serializable

Serialized Fields

eventName

String eventName

key

String key

operator

EventCondition.OperatorEnum operator

sessionType

String sessionType

streamType

EventCondition.StreamTypeEnum streamType

values

List<String> values

Class com.mypurecloud.sdk.v2.model.EventError

class EventError extends Object implements Serializable

Serialized Fields

eventId

String eventId

message

String message

retryable

Boolean retryable

Class com.mypurecloud.sdk.v2.model.EventListing

class EventListing extends Object implements Serializable

Serialized Fields

entities

List<Event> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.EventLog

class EventLog extends Object implements Serializable

Serialized Fields

category

EventLog.CategoryEnum category

correlationId

String correlationId

errorEntity

DomainEntityRef errorEntity

eventMessage

EventMessage eventMessage

id

String id

level

EventLog.LevelEnum level

name

String name

relatedEntity

DomainEntityRef relatedEntity

selfUri

String selfUri

timestamp

Date timestamp

Class com.mypurecloud.sdk.v2.model.EventMessage

class EventMessage extends Object implements Serializable

Serialized Fields

code

EventMessage.CodeEnum code

documentationUri

String documentationUri

message

String message

messageParams

Map<String,Object> messageParams

messageWithParams

String messageWithParams

resourceURIs

List<String> resourceURIs

Class com.mypurecloud.sdk.v2.model.EventPresence

class EventPresence extends Object implements Serializable

Serialized Fields

type

EventPresence.TypeEnum type

Class com.mypurecloud.sdk.v2.model.EventSession

class EventSession extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

type

String type

Class com.mypurecloud.sdk.v2.model.EventSetting

class EventSetting extends Object implements Serializable

Serialized Fields

typing

TypingSetting typing

Class com.mypurecloud.sdk.v2.model.EventTyping

class EventTyping extends Object implements Serializable

Serialized Fields

duration

Long duration

type

EventTyping.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ExecuteRecordingJobsQuery

class ExecuteRecordingJobsQuery extends Object implements Serializable

Serialized Fields

state

ExecuteRecordingJobsQuery.StateEnum state

Class com.mypurecloud.sdk.v2.model.ExecutionDataEntity

class ExecutionDataEntity extends Object implements Serializable

Serialized Fields

downloadUri

String downloadUri

failed

Boolean failed

id

String id

Class com.mypurecloud.sdk.v2.model.ExecutionDataRequest

class ExecutionDataRequest extends Object implements Serializable

Serialized Fields

ids

List<String> ids

Class com.mypurecloud.sdk.v2.model.ExpandableWebDeployment

class ExpandableWebDeployment extends Object implements Serializable

Serialized Fields

_configuration

WebDeploymentConfigurationVersionResponse _configuration

allowAllDomains

Boolean allowAllDomains

allowedDomains

List<String> allowedDomains

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

flow

DomainEntityRef flow

id

String id

lastModifiedUser

AddressableEntityRef lastModifiedUser

name

String name

selfUri

String selfUri

snippet

String snippet

status

ExpandableWebDeployment.StatusEnum status

supportedContentProfile

SupportedContentProfile supportedContentProfile

Class com.mypurecloud.sdk.v2.model.ExpandableWebDeploymentEntityListing

class ExpandableWebDeploymentEntityListing extends Object implements Serializable

Serialized Fields

entities

List<ExpandableWebDeployment> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ExpansionCriterium

class ExpansionCriterium extends Object implements Serializable

Serialized Fields

threshold

Double threshold

type

ExpansionCriterium.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ExpiredEdgeListing

class ExpiredEdgeListing extends Object implements Serializable

Serialized Fields

entities

List<DomainEntityRef> entities

Class com.mypurecloud.sdk.v2.model.ExportScriptRequest

class ExportScriptRequest extends Object implements Serializable

Serialized Fields

fileName

String fileName

versionId

String versionId

Class com.mypurecloud.sdk.v2.model.ExportScriptResponse

class ExportScriptResponse extends Object implements Serializable

Serialized Fields

url

String url

Class com.mypurecloud.sdk.v2.model.ExportUri

class ExportUri extends Object implements Serializable

Serialized Fields

exportTimestamp

Date exportTimestamp

uri

String uri

Class com.mypurecloud.sdk.v2.model.Extension

class Extension extends Object implements Serializable

Serialized Fields

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

extensionPool

DomainEntityRef extensionPool

id

String id

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

number

String number

owner

DomainEntityRef owner

ownerType

Extension.OwnerTypeEnum ownerType

selfUri

String selfUri

state

Extension.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.ExtensionEntityListing

class ExtensionEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Extension> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ExtensionPool

class ExtensionPool extends Object implements Serializable

Serialized Fields

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

endNumber

String endNumber

id

String id

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

selfUri

String selfUri

startNumber

String startNumber

state

ExtensionPool.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.ExtensionPoolDivisionView

class ExtensionPoolDivisionView extends Object implements Serializable

Serialized Fields

division

Division division

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ExtensionPoolDivisionViewEntityListing

class ExtensionPoolDivisionViewEntityListing extends Object implements Serializable

Serialized Fields

entities

List<ExtensionPoolDivisionView> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ExtensionPoolEntityListing

class ExtensionPoolEntityListing extends Object implements Serializable

Serialized Fields

entities

List<ExtensionPool> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ExternalContact

class ExternalContact extends Object implements Serializable

Serialized Fields

address

ContactAddress address

canonicalContact

ContactAddressableEntityRef canonicalContact

cellPhone

PhoneNumber cellPhone

createDate

Date createDate

customFields

Map<String,Object> customFields

externalDataSources

List<ExternalDataSource> externalDataSources

externalOrganization

ExternalOrganization externalOrganization

externalSystemUrl

String externalSystemUrl

facebookId

FacebookId facebookId

firstName

String firstName

homePhone

PhoneNumber homePhone

id

String id

lastName

String lastName

lineId

LineId lineId

mergeOperation

MergeOperation mergeOperation

mergeSet

List<ContactAddressableEntityRef> mergeSet

middleName

String middleName

modifyDate

Date modifyDate

otherEmail

String otherEmail

otherPhone

PhoneNumber otherPhone

personalEmail

String personalEmail

salutation

String salutation

schema

DataSchema schema

selfUri

String selfUri

surveyOptOut

Boolean surveyOptOut

title

String title

twitterId

TwitterId twitterId

type

ExternalContact.TypeEnum type

whatsAppId

WhatsAppId whatsAppId

workEmail

String workEmail

workPhone

PhoneNumber workPhone

Class com.mypurecloud.sdk.v2.model.ExternalContactReference

class ExternalContactReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ExternalContactsContactChangedTopicContact

class ExternalContactsContactChangedTopicContact extends Object implements Serializable

Serialized Fields

address

ExternalContactsContactChangedTopicContactAddress address

cellPhone

ExternalContactsContactChangedTopicPhoneNumber cellPhone

customFields

Map<String,Object> customFields

externalOrganization

ExternalContactsContactChangedTopicExternalOrganization externalOrganization

externalSystemUrl

String externalSystemUrl

facebookId

ExternalContactsContactChangedTopicFacebookId facebookId

firstName

String firstName

homePhone

ExternalContactsContactChangedTopicPhoneNumber homePhone

id

String id

instagramId

ExternalContactsContactChangedTopicInstagramId instagramId

lastName

String lastName

lineId

ExternalContactsContactChangedTopicLineId lineId

middleName

String middleName

otherEmail

String otherEmail

otherPhone

ExternalContactsContactChangedTopicPhoneNumber otherPhone

personalEmail

String personalEmail

salutation

String salutation

schema

ExternalContactsContactChangedTopicDataSchema schema

surveyOptOut

Boolean surveyOptOut

title

String title

twitterId

ExternalContactsContactChangedTopicTwitterId twitterId

type

ExternalContactsContactChangedTopicContact.TypeEnum type

whatsAppId

ExternalContactsContactChangedTopicWhatsAppId whatsAppId

workEmail

String workEmail

workPhone

ExternalContactsContactChangedTopicPhoneNumber workPhone

Class com.mypurecloud.sdk.v2.model.ExternalContactsContactChangedTopicContactAddress

class ExternalContactsContactChangedTopicContactAddress extends Object implements Serializable

Serialized Fields

address1

String address1

address2

String address2

city

String city

countryCode

String countryCode

postalCode

String postalCode

state

String state

Class com.mypurecloud.sdk.v2.model.ExternalContactsContactChangedTopicDataSchema

class ExternalContactsContactChangedTopicDataSchema extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.ExternalContactsContactChangedTopicExternalOrganization

class ExternalContactsContactChangedTopicExternalOrganization extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.ExternalContactsContactChangedTopicFacebookId

class ExternalContactsContactChangedTopicFacebookId extends Object implements Serializable

Serialized Fields

displayName

String displayName

ids

List<ExternalContactsContactChangedTopicFacebookScopedId> ids

Class com.mypurecloud.sdk.v2.model.ExternalContactsContactChangedTopicFacebookScopedId

class ExternalContactsContactChangedTopicFacebookScopedId extends Object implements Serializable

Serialized Fields

scopedId

String scopedId

Class com.mypurecloud.sdk.v2.model.ExternalContactsContactChangedTopicInstagramId

class ExternalContactsContactChangedTopicInstagramId extends Object implements Serializable

Serialized Fields

displayName

String displayName

ids

List<ExternalContactsContactChangedTopicInstagramScopedId> ids

Class com.mypurecloud.sdk.v2.model.ExternalContactsContactChangedTopicInstagramScopedId

class ExternalContactsContactChangedTopicInstagramScopedId extends Object implements Serializable

Serialized Fields

scopedId

String scopedId

Class com.mypurecloud.sdk.v2.model.ExternalContactsContactChangedTopicLineId

class ExternalContactsContactChangedTopicLineId extends Object implements Serializable

Serialized Fields

displayName

String displayName

ids

List<ExternalContactsContactChangedTopicLineUserId> ids

Class com.mypurecloud.sdk.v2.model.ExternalContactsContactChangedTopicLineUserId

class ExternalContactsContactChangedTopicLineUserId extends Object implements Serializable

Serialized Fields

userId

String userId

Class com.mypurecloud.sdk.v2.model.ExternalContactsContactChangedTopicObject

class ExternalContactsContactChangedTopicObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.ExternalContactsContactChangedTopicPhoneNumber

class ExternalContactsContactChangedTopicPhoneNumber extends Object implements Serializable

Serialized Fields

acceptsSMS

Boolean acceptsSMS

countryCode

String countryCode

display

String display

e164

String e164

extension

Integer extension

userInput

String userInput

Class com.mypurecloud.sdk.v2.model.ExternalContactsContactChangedTopicTwitterId

class ExternalContactsContactChangedTopicTwitterId extends Object implements Serializable

Serialized Fields

id

String id

name

String name

profileUrl

String profileUrl

screenName

String screenName

verified

Boolean verified

Class com.mypurecloud.sdk.v2.model.ExternalContactsContactChangedTopicWhatsAppId

class ExternalContactsContactChangedTopicWhatsAppId extends Object implements Serializable

Serialized Fields

displayName

String displayName

phoneNumber

ExternalContactsContactChangedTopicPhoneNumber phoneNumber

Class com.mypurecloud.sdk.v2.model.ExternalContactsUnresolvedContactChangedTopicContact

class ExternalContactsUnresolvedContactChangedTopicContact extends Object implements Serializable

Serialized Fields

address

ExternalContactsUnresolvedContactChangedTopicContactAddress address

cellPhone

ExternalContactsUnresolvedContactChangedTopicPhoneNumber cellPhone

customFields

Map<String,Object> customFields

externalOrganization

ExternalContactsUnresolvedContactChangedTopicExternalOrganization externalOrganization

externalSystemUrl

String externalSystemUrl

facebookId

ExternalContactsUnresolvedContactChangedTopicFacebookId facebookId

firstName

String firstName

homePhone

ExternalContactsUnresolvedContactChangedTopicPhoneNumber homePhone

id

String id

instagramId

ExternalContactsUnresolvedContactChangedTopicInstagramId instagramId

lastName

String lastName

lineId

ExternalContactsUnresolvedContactChangedTopicLineId lineId

middleName

String middleName

otherEmail

String otherEmail

otherPhone

ExternalContactsUnresolvedContactChangedTopicPhoneNumber otherPhone

personalEmail

String personalEmail

salutation

String salutation

schema

ExternalContactsUnresolvedContactChangedTopicDataSchema schema

surveyOptOut

Boolean surveyOptOut

title

String title

twitterId

ExternalContactsUnresolvedContactChangedTopicTwitterId twitterId

type

ExternalContactsUnresolvedContactChangedTopicContact.TypeEnum type

whatsAppId

ExternalContactsUnresolvedContactChangedTopicWhatsAppId whatsAppId

workEmail

String workEmail

workPhone

ExternalContactsUnresolvedContactChangedTopicPhoneNumber workPhone

Class com.mypurecloud.sdk.v2.model.ExternalContactsUnresolvedContactChangedTopicContactAddress

class ExternalContactsUnresolvedContactChangedTopicContactAddress extends Object implements Serializable

Serialized Fields

address1

String address1

address2

String address2

city

String city

countryCode

String countryCode

postalCode

String postalCode

state

String state

Class com.mypurecloud.sdk.v2.model.ExternalContactsUnresolvedContactChangedTopicDataSchema

class ExternalContactsUnresolvedContactChangedTopicDataSchema extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.ExternalContactsUnresolvedContactChangedTopicExternalOrganization

class ExternalContactsUnresolvedContactChangedTopicExternalOrganization extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.ExternalContactsUnresolvedContactChangedTopicFacebookId

class ExternalContactsUnresolvedContactChangedTopicFacebookId extends Object implements Serializable

Serialized Fields

displayName

String displayName

ids

List<ExternalContactsUnresolvedContactChangedTopicFacebookScopedId> ids

Class com.mypurecloud.sdk.v2.model.ExternalContactsUnresolvedContactChangedTopicFacebookScopedId

class ExternalContactsUnresolvedContactChangedTopicFacebookScopedId extends Object implements Serializable

Serialized Fields

scopedId

String scopedId

Class com.mypurecloud.sdk.v2.model.ExternalContactsUnresolvedContactChangedTopicInstagramId

class ExternalContactsUnresolvedContactChangedTopicInstagramId extends Object implements Serializable

Serialized Fields

displayName

String displayName

ids

List<ExternalContactsUnresolvedContactChangedTopicInstagramScopedId> ids

Class com.mypurecloud.sdk.v2.model.ExternalContactsUnresolvedContactChangedTopicInstagramScopedId

class ExternalContactsUnresolvedContactChangedTopicInstagramScopedId extends Object implements Serializable

Serialized Fields

scopedId

String scopedId

Class com.mypurecloud.sdk.v2.model.ExternalContactsUnresolvedContactChangedTopicLineId

class ExternalContactsUnresolvedContactChangedTopicLineId extends Object implements Serializable

Serialized Fields

displayName

String displayName

ids

List<ExternalContactsUnresolvedContactChangedTopicLineUserId> ids

Class com.mypurecloud.sdk.v2.model.ExternalContactsUnresolvedContactChangedTopicLineUserId

class ExternalContactsUnresolvedContactChangedTopicLineUserId extends Object implements Serializable

Serialized Fields

userId

String userId

Class com.mypurecloud.sdk.v2.model.ExternalContactsUnresolvedContactChangedTopicObject

class ExternalContactsUnresolvedContactChangedTopicObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.ExternalContactsUnresolvedContactChangedTopicPhoneNumber

class ExternalContactsUnresolvedContactChangedTopicPhoneNumber extends Object implements Serializable

Serialized Fields

acceptsSMS

Boolean acceptsSMS

countryCode

String countryCode

display

String display

e164

String e164

extension

Integer extension

userInput

String userInput

Class com.mypurecloud.sdk.v2.model.ExternalContactsUnresolvedContactChangedTopicTwitterId

class ExternalContactsUnresolvedContactChangedTopicTwitterId extends Object implements Serializable

Serialized Fields

id

String id

name

String name

profileUrl

String profileUrl

screenName

String screenName

verified

Boolean verified

Class com.mypurecloud.sdk.v2.model.ExternalContactsUnresolvedContactChangedTopicWhatsAppId

class ExternalContactsUnresolvedContactChangedTopicWhatsAppId extends Object implements Serializable

Serialized Fields

displayName

String displayName

phoneNumber

ExternalContactsUnresolvedContactChangedTopicPhoneNumber phoneNumber

Class com.mypurecloud.sdk.v2.model.ExternalDataSource

class ExternalDataSource extends Object implements Serializable

Serialized Fields

platform

ExternalDataSource.PlatformEnum platform

url

String url

Class com.mypurecloud.sdk.v2.model.ExternalEstablishedEvent

class ExternalEstablishedEvent extends Object implements Serializable

Serialized Fields

ani

String ani

aniName

String aniName

communicationId

String communicationId

conversationId

String conversationId

dnis

String dnis

dnisName

String dnisName

eventDateTime

Date eventDateTime

eventId

String eventId

initialConfiguration

InitialConfiguration initialConfiguration

sourceConfiguration

SourceConfiguration sourceConfiguration

Class com.mypurecloud.sdk.v2.model.ExternalMetricDataItem

class ExternalMetricDataItem extends Object implements Serializable

Serialized Fields

count

Integer count

dateOccurred

LocalDate dateOccurred

metricId

String metricId

type

ExternalMetricDataItem.TypeEnum type

userEmail

String userEmail

userId

String userId

value

BigDecimal value

Class com.mypurecloud.sdk.v2.model.ExternalMetricDataProcessedItem

class ExternalMetricDataProcessedItem extends Object implements Serializable

Serialized Fields

count

Integer count

dateOccurred

LocalDate dateOccurred

metricId

String metricId

totalCount

Integer totalCount

totalValue

BigDecimal totalValue

type

ExternalMetricDataProcessedItem.TypeEnum type

userEmail

String userEmail

userId

String userId

value

BigDecimal value

Class com.mypurecloud.sdk.v2.model.ExternalMetricDataUnprocessedItem

class ExternalMetricDataUnprocessedItem extends Object implements Serializable

Serialized Fields

code

String code

count

Integer count

dateOccurred

LocalDate dateOccurred

message

String message

metricId

String metricId

type

ExternalMetricDataUnprocessedItem.TypeEnum type

userEmail

String userEmail

userId

String userId

value

BigDecimal value

Class com.mypurecloud.sdk.v2.model.ExternalMetricDataWriteRequest

class ExternalMetricDataWriteRequest extends Object implements Serializable

Serialized Fields

items

List<ExternalMetricDataItem> items

Class com.mypurecloud.sdk.v2.model.ExternalMetricDataWriteResponse

class ExternalMetricDataWriteResponse extends Object implements Serializable

Serialized Fields

processedEntities

List<ExternalMetricDataProcessedItem> processedEntities

unprocessedEntities

List<ExternalMetricDataUnprocessedItem> unprocessedEntities

Class com.mypurecloud.sdk.v2.model.ExternalMetricDefinition

class ExternalMetricDefinition extends Object implements Serializable

Serialized Fields

dateLastRefreshed

Date dateLastRefreshed

defaultObjectiveType

ExternalMetricDefinition.DefaultObjectiveTypeEnum defaultObjectiveType

enabled

Boolean enabled

id

String id

inUse

Boolean inUse

name

String name

precision

Integer precision

retentionMonths

Integer retentionMonths

selfUri

String selfUri

unit

ExternalMetricDefinition.UnitEnum unit

unitDefinition

String unitDefinition

Class com.mypurecloud.sdk.v2.model.ExternalMetricDefinitionCreateRequest

class ExternalMetricDefinitionCreateRequest extends Object implements Serializable

Serialized Fields

defaultObjectiveType

ExternalMetricDefinitionCreateRequest.DefaultObjectiveTypeEnum defaultObjectiveType

enabled

Boolean enabled

name

String name

precision

Integer precision

unit

ExternalMetricDefinitionCreateRequest.UnitEnum unit

unitDefinition

String unitDefinition

Class com.mypurecloud.sdk.v2.model.ExternalMetricDefinitionListing

class ExternalMetricDefinitionListing extends Object implements Serializable

Serialized Fields

entities

List<ExternalMetricDefinition> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ExternalMetricDefinitionUpdateRequest

class ExternalMetricDefinitionUpdateRequest extends Object implements Serializable

Serialized Fields

defaultObjectiveType

ExternalMetricDefinitionUpdateRequest.DefaultObjectiveTypeEnum defaultObjectiveType

enabled

Boolean enabled

name

String name

precision

Integer precision

Class com.mypurecloud.sdk.v2.model.ExternalOrganization

class ExternalOrganization extends Object implements Serializable

Serialized Fields

address

ContactAddress address

companyType

String companyType

createDate

Date createDate

customFields

Map<String,Object> customFields

employeeCount

Long employeeCount

externalDataSources

List<ExternalDataSource> externalDataSources

externalSystemUrl

String externalSystemUrl

faxNumber

PhoneNumber faxNumber

id

String id

industry

String industry

modifyDate

Date modifyDate

name

String name

phoneNumber

PhoneNumber phoneNumber

primaryContactId

String primaryContactId

revenue

Long revenue

schema

DataSchema schema

selfUri

String selfUri

tags

List<String> tags

tickers

List<Ticker> tickers

trustor

Trustor trustor

twitterId

TwitterId twitterId

websites

List<String> websites

Class com.mypurecloud.sdk.v2.model.ExternalOrganizationListing

class ExternalOrganizationListing extends Object implements Serializable

Serialized Fields

entities

List<ExternalOrganization> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

partialResults

Boolean partialResults

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ExternalOrganizationTrustorLink

class ExternalOrganizationTrustorLink extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

externalOrganizationId

String externalOrganizationId

externalOrganizationUri

String externalOrganizationUri

trustorOrgId

String trustorOrgId

Class com.mypurecloud.sdk.v2.model.ExternalSegment

class ExternalSegment extends Object implements Serializable

Serialized Fields

id

String id

name

String name

source

ExternalSegment.SourceEnum source

Class com.mypurecloud.sdk.v2.model.FacebookAppCredentials

class FacebookAppCredentials extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.FacebookId

class FacebookId extends Object implements Serializable

Serialized Fields

displayName

String displayName

ids

List<FacebookScopedId> ids

Class com.mypurecloud.sdk.v2.model.FacebookIntegration

class FacebookIntegration extends Object implements Serializable

Serialized Fields

appId

String appId

createdBy

DomainEntityRef createdBy

createError

ErrorBody createError

createStatus

FacebookIntegration.CreateStatusEnum createStatus

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

messagingSetting

MessagingSettingReference messagingSetting

modifiedBy

DomainEntityRef modifiedBy

name

String name

pageId

String pageId

pageName

String pageName

pageProfileImageUrl

String pageProfileImageUrl

recipient

DomainEntityRef recipient

selfUri

String selfUri

status

String status

supportedContent

SupportedContentReference supportedContent

version

Integer version

Class com.mypurecloud.sdk.v2.model.FacebookIntegrationEntityListing

class FacebookIntegrationEntityListing extends Object implements Serializable

Serialized Fields

entities

List<FacebookIntegration> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.FacebookIntegrationRequest

class FacebookIntegrationRequest extends Object implements Serializable

Serialized Fields

appId

String appId

appSecret

String appSecret

id

String id

messagingSetting

MessagingSettingRequestReference messagingSetting

name

String name

pageAccessToken

String pageAccessToken

pageId

String pageId

selfUri

String selfUri

supportedContent

SupportedContentReference supportedContent

userAccessToken

String userAccessToken

Class com.mypurecloud.sdk.v2.model.FacebookIntegrationUpdateRequest

class FacebookIntegrationUpdateRequest extends Object implements Serializable

Serialized Fields

id

String id

messagingSetting

MessagingSettingRequestReference messagingSetting

name

String name

pageAccessToken

String pageAccessToken

selfUri

String selfUri

supportedContent

SupportedContentReference supportedContent

userAccessToken

String userAccessToken

Class com.mypurecloud.sdk.v2.model.FacebookScopedId

class FacebookScopedId extends Object implements Serializable

Serialized Fields

scopedId

String scopedId

Class com.mypurecloud.sdk.v2.model.Facet

class Facet extends Object implements Serializable

Serialized Fields

name

String name

type

String type

Class com.mypurecloud.sdk.v2.model.FacetEntry

class FacetEntry extends Object implements Serializable

Serialized Fields

attribute

TermAttribute attribute

missing

Long missing

other

Long other

statistics

FacetStatistics statistics

termCount

Integer termCount

terms

List<FacetTerm> terms

termType

FacetEntry.TermTypeEnum termType

total

Long total

Class com.mypurecloud.sdk.v2.model.FacetInfo

class FacetInfo extends Object implements Serializable

Serialized Fields

entries

List<Entry> entries

name

String name

Class com.mypurecloud.sdk.v2.model.FacetKeyAttribute

class FacetKeyAttribute extends Object implements Serializable

Serialized Fields

count

Integer count

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.FacetStatistics

class FacetStatistics extends Object implements Serializable

Serialized Fields

count

Long count

dateMax

Date dateMax

dateMin

Date dateMin

max

Double max

mean

Double mean

min

Double min

stdDeviation

Double stdDeviation

Class com.mypurecloud.sdk.v2.model.FacetTerm

class FacetTerm extends Object implements Serializable

Serialized Fields

count

Long count

id

String id

key

Long key

name

String name

term

String term

time

Date time

Class com.mypurecloud.sdk.v2.model.FailedObject

class FailedObject extends Object implements Serializable

Serialized Fields

errorCode

String errorCode

id

String id

name

String name

version

String version

Class com.mypurecloud.sdk.v2.model.FailedRecordingEntityListing

class FailedRecordingEntityListing extends Object implements Serializable

Serialized Fields

entities

List<RecordingJobFailedRecording> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.FaxDocument

class FaxDocument extends Object implements Serializable

Serialized Fields

callerAddress

String callerAddress

contentLength

Long contentLength

contentType

String contentType

contentUri

String contentUri

createdBy

DomainEntityRef createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

downloadSharingUri

String downloadSharingUri

filename

String filename

id

String id

name

String name

pageCount

Long pageCount

read

Boolean read

receiverAddress

String receiverAddress

selfUri

String selfUri

sharingUri

String sharingUri

thumbnails

List<DocumentThumbnail> thumbnails

workspace

DomainEntityRef workspace

Class com.mypurecloud.sdk.v2.model.FaxDocumentEntityListing

class FaxDocumentEntityListing extends Object implements Serializable

Serialized Fields

entities

List<FaxDocument> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.FaxSendRequest

class FaxSendRequest extends Object implements Serializable

Serialized Fields

addresses

List<String> addresses

contentType

FaxSendRequest.ContentTypeEnum contentType

coverSheet

CoverSheet coverSheet

documentId

String documentId

id

String id

name

String name

selfUri

String selfUri

timeZoneOffsetMinutes

Integer timeZoneOffsetMinutes

workspace

Workspace workspace

Class com.mypurecloud.sdk.v2.model.FaxSendResponse

class FaxSendResponse extends Object implements Serializable

Serialized Fields

headers

Map<String,String> headers

id

String id

name

String name

selfUri

String selfUri

uploadDestinationUri

String uploadDestinationUri

uploadMethodType

FaxSendResponse.UploadMethodTypeEnum uploadMethodType

Class com.mypurecloud.sdk.v2.model.FaxStatus

class FaxStatus extends Object implements Serializable

Serialized Fields

activePage

Long activePage

baudRate

Long baudRate

bytesTransmitted

Long bytesTransmitted

direction

String direction

expectedPages

Long expectedPages

lineErrors

Long lineErrors

linesTransmitted

Long linesTransmitted

pageErrors

Long pageErrors

Class com.mypurecloud.sdk.v2.model.FaxSummary

class FaxSummary extends Object implements Serializable

Serialized Fields

readCount

Integer readCount

totalCount

Integer totalCount

unreadCount

Integer unreadCount

Class com.mypurecloud.sdk.v2.model.FaxTopicFaxDataV2

class FaxTopicFaxDataV2 extends Object implements Serializable

Serialized Fields

callerAddress

String callerAddress

changeNumber

Integer changeNumber

contentLength

Integer contentLength

contentType

String contentType

createdBy

FaxTopicUserData createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

dateUploaded

Date dateUploaded

filename

String filename

id

String id

lockInfo

FaxTopicLockData lockInfo

name

String name

read

Boolean read

receiverAddress

String receiverAddress

selfUri

String selfUri

uploadedBy

FaxTopicUserData uploadedBy

workspace

FaxTopicWorkspaceData workspace

Class com.mypurecloud.sdk.v2.model.FaxTopicLockData

class FaxTopicLockData extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateExpires

Date dateExpires

lockedBy

FaxTopicUserData lockedBy

Class com.mypurecloud.sdk.v2.model.FaxTopicUserData

class FaxTopicUserData extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.FaxTopicWorkspaceData

class FaxTopicWorkspaceData extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.FeatureState

class FeatureState extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

Class com.mypurecloud.sdk.v2.model.FieldConfig

class FieldConfig extends Object implements Serializable

Serialized Fields

entityType

FieldConfig.EntityTypeEnum entityType

id

String id

name

String name

schemaVersion

String schemaVersion

sections

List<Section> sections

selfUri

String selfUri

state

String state

version

String version

Class com.mypurecloud.sdk.v2.model.FieldConfigs

class FieldConfigs extends Object implements Serializable

Serialized Fields

externalContact

FieldConfig externalContact

group

FieldConfig group

org

FieldConfig org

person

FieldConfig person

Class com.mypurecloud.sdk.v2.model.FieldList

class FieldList extends Object implements Serializable

Serialized Fields

customLabels

Boolean customLabels

gdpr

Boolean gdpr

instructionText

String instructionText

key

String key

labelKeys

List<String> labelKeys

params

Map<String,Object> params

repeatable

Boolean repeatable

required

Boolean required

state

String state

type

String type

Class com.mypurecloud.sdk.v2.model.FileUploadMode

class FileUploadMode extends Object implements Serializable

Serialized Fields

fileTypes

List<FileUploadMode.FileTypesEnum> fileTypes

maxFileSizeKB

Long maxFileSizeKB

Class com.mypurecloud.sdk.v2.model.FileUploadSettings

class FileUploadSettings extends Object implements Serializable

Serialized Fields

enableAttachments

Boolean enableAttachments

modes

List<FileUploadMode> modes

useSupportedContentProfile

Boolean useSupportedContentProfile

Class com.mypurecloud.sdk.v2.model.Filter

class Filter extends Object implements Serializable

Serialized Fields

name

String name

operator

String operator

type

String type

values

List<String> values

Class com.mypurecloud.sdk.v2.model.FilterPreviewResponse

class FilterPreviewResponse extends Object implements Serializable

Serialized Fields

filteredContacts

Long filteredContacts

preview

List<DialerContact> preview

totalContacts

Long totalContacts

Class com.mypurecloud.sdk.v2.model.Flow

class Flow extends Object implements Serializable

Serialized Fields

active

Boolean active

checkedInVersion

FlowVersion checkedInVersion

compatibleFlowTypes

List<Flow.CompatibleFlowTypesEnum> compatibleFlowTypes

currentOperation

Operation currentOperation

debugVersion

FlowVersion debugVersion

deleted

Boolean deleted

description

String description

division

WritableDivision division

id

String id

inputSchema

Object inputSchema

lockedClient

DomainEntityRef lockedClient

lockedUser

User lockedUser

name

String name

nluInfo

NluInfo nluInfo

outputSchema

Object outputSchema

publishedBy

User publishedBy

publishedVersion

FlowVersion publishedVersion

savedVersion

FlowVersion savedVersion

selfUri

String selfUri

supportedLanguages

List<SupportedLanguage> supportedLanguages

system

Boolean system

type

Flow.TypeEnum type

Class com.mypurecloud.sdk.v2.model.FlowActivityData

class FlowActivityData extends Object implements Serializable

Serialized Fields

data

List<FlowActivityMetricValue> data

entities

List<FlowActivityEntityData> entities

group

Map<String,String> group

truncated

Boolean truncated

Class com.mypurecloud.sdk.v2.model.FlowActivityEntityData

class FlowActivityEntityData extends Object implements Serializable

Serialized Fields

activityDate

Date activityDate

addressFrom

String addressFrom

addressTo

String addressTo

ani

String ani

conversationId

String conversationId

convertedFrom

String convertedFrom

convertedTo

String convertedTo

direction

FlowActivityEntityData.DirectionEnum direction

dnis

String dnis

flowId

String flowId

flowType

FlowActivityEntityData.FlowTypeEnum flowType

mediaType

FlowActivityEntityData.MediaTypeEnum mediaType

metric

FlowActivityEntityData.MetricEnum metric

participantName

String participantName

queueId

String queueId

requestedLanguageId

String requestedLanguageId

requestedRoutings

List<FlowActivityEntityData.RequestedRoutingsEnum> requestedRoutings

requestedRoutingSkillIds

List<String> requestedRoutingSkillIds

routingPriority

Long routingPriority

scoredAgents

List<FlowActivityScoredAgent> scoredAgents

sessionId

String sessionId

teamId

String teamId

usedRouting

FlowActivityEntityData.UsedRoutingEnum usedRouting

userId

String userId

Class com.mypurecloud.sdk.v2.model.FlowActivityMetricValue

class FlowActivityMetricValue extends Object implements Serializable

Serialized Fields

count

Integer count

metric

FlowActivityMetricValue.MetricEnum metric

Class com.mypurecloud.sdk.v2.model.FlowActivityQuery

class FlowActivityQuery extends Object implements Serializable

Serialized Fields

filter

FlowActivityQueryFilter filter

groupBy

List<FlowActivityQuery.GroupByEnum> groupBy

metrics

List<FlowActivityQueryMetric> metrics

order

FlowActivityQuery.OrderEnum order

Class com.mypurecloud.sdk.v2.model.FlowActivityQueryClause

class FlowActivityQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<FlowActivityQueryPredicate> predicates

type

FlowActivityQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.FlowActivityQueryFilter

class FlowActivityQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<FlowActivityQueryClause> clauses

predicates

List<FlowActivityQueryPredicate> predicates

type

FlowActivityQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.FlowActivityQueryMetric

class FlowActivityQueryMetric extends Object implements Serializable

Serialized Fields

details

Boolean details

metric

FlowActivityQueryMetric.MetricEnum metric

Class com.mypurecloud.sdk.v2.model.FlowActivityQueryPredicate

class FlowActivityQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

FlowActivityQueryPredicate.DimensionEnum dimension

operator

FlowActivityQueryPredicate.OperatorEnum operator

type

FlowActivityQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.FlowActivityResponse

class FlowActivityResponse extends Object implements Serializable

Serialized Fields

entityIdDimension

FlowActivityResponse.EntityIdDimensionEnum entityIdDimension

results

List<FlowActivityData> results

Class com.mypurecloud.sdk.v2.model.FlowActivityScoredAgent

class FlowActivityScoredAgent extends Object implements Serializable

Serialized Fields

agentScore

Integer agentScore

scoredAgentId

String scoredAgentId

Class com.mypurecloud.sdk.v2.model.FlowAggregateDataContainer

class FlowAggregateDataContainer extends Object implements Serializable

Serialized Fields

data

List<StatisticalResponse> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.FlowAggregateQueryClause

class FlowAggregateQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<FlowAggregateQueryPredicate> predicates

type

FlowAggregateQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.FlowAggregateQueryFilter

class FlowAggregateQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<FlowAggregateQueryClause> clauses

predicates

List<FlowAggregateQueryPredicate> predicates

type

FlowAggregateQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.FlowAggregateQueryPredicate

class FlowAggregateQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

FlowAggregateQueryPredicate.DimensionEnum dimension

operator

FlowAggregateQueryPredicate.OperatorEnum operator

range

NumericRange range

type

FlowAggregateQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.FlowAggregateQueryResponse

class FlowAggregateQueryResponse extends Object implements Serializable

Serialized Fields

results

List<FlowAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.FlowAggregationQuery

class FlowAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

FlowAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

FlowAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<FlowAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<FlowAggregationQuery.MetricsEnum> metrics

timeZone

String timeZone

views

List<FlowAggregationView> views

Class com.mypurecloud.sdk.v2.model.FlowAggregationView

class FlowAggregationView extends Object implements Serializable

Serialized Fields

function

FlowAggregationView.FunctionEnum function

name

String name

range

AggregationRange range

target

FlowAggregationView.TargetEnum target

Class com.mypurecloud.sdk.v2.model.FlowAsyncAggregateQueryResponse

class FlowAsyncAggregateQueryResponse extends Object implements Serializable

Serialized Fields

cursor

String cursor

results

List<FlowAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.FlowAsyncAggregationQuery

class FlowAsyncAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

FlowAsyncAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

FlowAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<FlowAsyncAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<FlowAsyncAggregationQuery.MetricsEnum> metrics

pageSize

Integer pageSize

timeZone

String timeZone

views

List<FlowAggregationView> views

Class com.mypurecloud.sdk.v2.model.FlowDiagnosticInfo

class FlowDiagnosticInfo extends Object implements Serializable

Serialized Fields

lastActionId

Integer lastActionId

Class com.mypurecloud.sdk.v2.model.FlowDivisionView

class FlowDivisionView extends Object implements Serializable

Serialized Fields

debugVersion

FlowVersion debugVersion

description

String description

division

WritableDivision division

id

String id

inputSchema

JsonSchemaDocument inputSchema

name

String name

outputSchema

JsonSchemaDocument outputSchema

publishedVersion

FlowVersion publishedVersion

selfUri

String selfUri

supportedLanguages

List<SupportedLanguage> supportedLanguages

type

FlowDivisionView.TypeEnum type

Class com.mypurecloud.sdk.v2.model.FlowDivisionViewEntityListing

class FlowDivisionViewEntityListing extends Object implements Serializable

Serialized Fields

entities

List<FlowDivisionView> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.FlowEndDetailEventTopicFlowEndEvent

class FlowEndDetailEventTopicFlowEndEvent extends Object implements Serializable

Serialized Fields

addressFrom

String addressFrom

addressTo

String addressTo

ani

String ani

connectedDurationMs

Integer connectedDurationMs

conversationExternalContactIds

List<String> conversationExternalContactIds

conversationExternalOrganizationIds

List<String> conversationExternalOrganizationIds

conversationId

String conversationId

direction

FlowEndDetailEventTopicFlowEndEvent.DirectionEnum direction

disconnectType

FlowEndDetailEventTopicFlowEndEvent.DisconnectTypeEnum disconnectType

divisionId

String divisionId

dnis

String dnis

eventTime

Integer eventTime

flowId

String flowId

flowType

FlowEndDetailEventTopicFlowEndEvent.FlowTypeEnum flowType

flowVersion

String flowVersion

mediaType

FlowEndDetailEventTopicFlowEndEvent.MediaTypeEnum mediaType

messageType

FlowEndDetailEventTopicFlowEndEvent.MessageTypeEnum messageType

participantId

String participantId

provider

String provider

sessionId

String sessionId

subject

String subject

Class com.mypurecloud.sdk.v2.model.FlowEntityListing

class FlowEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Flow> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.FlowExecutionDataQueryResult

class FlowExecutionDataQueryResult extends Object implements Serializable

Serialized Fields

conversationId

String conversationId

endDateTime

Date endDateTime

flowErrorReason

String flowErrorReason

flowId

String flowId

flowName

String flowName

flowType

FlowExecutionDataQueryResult.FlowTypeEnum flowType

flowVersion

String flowVersion

id

String id

name

String name

selfUri

String selfUri

startDateTime

Date startDateTime

Class com.mypurecloud.sdk.v2.model.FlowExecutionLaunchRequest

class FlowExecutionLaunchRequest extends Object implements Serializable

Serialized Fields

flowId

String flowId

flowVersion

String flowVersion

inputData

Map<String,Object> inputData

name

String name

Class com.mypurecloud.sdk.v2.model.FlowExecutionLaunchResponse

class FlowExecutionLaunchResponse extends Object implements Serializable

Serialized Fields

flowVersion

DomainEntityRef flowVersion

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.FlowMetricsTopicFlowMetricRecord

class FlowMetricsTopicFlowMetricRecord extends Object implements Serializable

Serialized Fields

activeSkillIds

List<String> activeSkillIds

addressFrom

String addressFrom

addressTo

String addressTo

agentAssistantId

String agentAssistantId

agentBullseyeRing

Integer agentBullseyeRing

agentOwned

Boolean agentOwned

ani

String ani

assignerId

String assignerId

authenticated

Boolean authenticated

conversationId

String conversationId

conversationInitiator

FlowMetricsTopicFlowMetricRecord.ConversationInitiatorEnum conversationInitiator

convertedFrom

String convertedFrom

convertedTo

String convertedTo

customerParticipation

Boolean customerParticipation

deliveryStatus

FlowMetricsTopicFlowMetricRecord.DeliveryStatusEnum deliveryStatus

destinationAddresses

List<String> destinationAddresses

direction

FlowMetricsTopicFlowMetricRecord.DirectionEnum direction

disconnectType

FlowMetricsTopicFlowMetricRecord.DisconnectTypeEnum disconnectType

divisionIds

List<String> divisionIds

dnis

String dnis

edgeId

String edgeId

eligibleAgentCounts

List<Integer> eligibleAgentCounts

endingLanguage

String endingLanguage

entryReason

String entryReason

entryType

FlowMetricsTopicFlowMetricRecord.EntryTypeEnum entryType

errorCode

String errorCode

exitReason

String exitReason

extendedDeliveryStatus

String extendedDeliveryStatus

externalContactId

String externalContactId

externalMediaCount

Integer externalMediaCount

externalOrganizationId

String externalOrganizationId

externalTag

String externalTag

firstQueue

Boolean firstQueue

flaggedReason

FlowMetricsTopicFlowMetricRecord.FlaggedReasonEnum flaggedReason

flowId

String flowId

flowInType

String flowInType

flowMilestoneIds

List<String> flowMilestoneIds

flowName

String flowName

flowOutType

String flowOutType

flowType

FlowMetricsTopicFlowMetricRecord.FlowTypeEnum flowType

flowVersion

String flowVersion

groupId

String groupId

interactionType

String interactionType

journeyActionId

String journeyActionId

journeyActionMapId

String journeyActionMapId

journeyActionMapVersion

Integer journeyActionMapVersion

journeyCustomerId

String journeyCustomerId

journeyCustomerIdType

String journeyCustomerIdType

journeyCustomerSessionId

String journeyCustomerSessionId

journeyCustomerSessionIdType

String journeyCustomerSessionIdType

knowledgeBaseId

String knowledgeBaseId

mediaCount

Integer mediaCount

mediaType

FlowMetricsTopicFlowMetricRecord.MediaTypeEnum mediaType

messageType

String messageType

metric

FlowMetricsTopicFlowMetricRecord.MetricEnum metric

metricDate

Date metricDate

originatingDirection

FlowMetricsTopicFlowMetricRecord.OriginatingDirectionEnum originatingDirection

outboundCampaignId

String outboundCampaignId

outboundContactId

String outboundContactId

outboundContactListId

String outboundContactListId

outcomes

List<FlowMetricsTopicFlowOutcome> outcomes

participantName

String participantName

peerId

String peerId

proposedAgents

List<FlowMetricsTopicFlowProposedAgent> proposedAgents

provider

String provider

purpose

FlowMetricsTopicFlowMetricRecord.PurposeEnum purpose

queueId

String queueId

recognitionFailureReason

String recognitionFailureReason

recordId

String recordId

remote

String remote

removedSkillIds

List<String> removedSkillIds

reoffered

Boolean reoffered

requestedLanguageId

String requestedLanguageId

requestedRoutings

List<FlowMetricsTopicFlowMetricRecord.RequestedRoutingsEnum> requestedRoutings

requestedRoutingSkillIds

List<String> requestedRoutingSkillIds

roomId

String roomId

routingPriority

Integer routingPriority

routingRing

Integer routingRing

scoredAgents

List<FlowMetricsTopicFlowScoredAgent> scoredAgents

selectedAgentId

String selectedAgentId

selectedAgentRank

Integer selectedAgentRank

selfServed

Boolean selfServed

sessionDnis

String sessionDnis

sessionId

String sessionId

startingLanguage

String startingLanguage

stationId

String stationId

teamId

String teamId

transferTargetAddress

String transferTargetAddress

transferTargetName

String transferTargetName

transferType

String transferType

usedRouting

FlowMetricsTopicFlowMetricRecord.UsedRoutingEnum usedRouting

userId

String userId

value

Integer value

waitingInteractionCounts

List<Integer> waitingInteractionCounts

wrapUpCode

String wrapUpCode

Class com.mypurecloud.sdk.v2.model.FlowMetricsTopicFlowOutcome

class FlowMetricsTopicFlowOutcome extends Object implements Serializable

Serialized Fields

flowOutcome

String flowOutcome

flowOutcomeId

String flowOutcomeId

flowOutcomeValue

String flowOutcomeValue

Class com.mypurecloud.sdk.v2.model.FlowMetricsTopicFlowProposedAgent

class FlowMetricsTopicFlowProposedAgent extends Object implements Serializable

Serialized Fields

agentRank

Integer agentRank

proposedAgentId

String proposedAgentId

Class com.mypurecloud.sdk.v2.model.FlowMetricsTopicFlowScoredAgent

class FlowMetricsTopicFlowScoredAgent extends Object implements Serializable

Serialized Fields

agentScore

Integer agentScore

scoredAgentId

String scoredAgentId

Class com.mypurecloud.sdk.v2.model.FlowMilestone

class FlowMilestone extends Object implements Serializable

Serialized Fields

description

String description

division

WritableDivision division

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.FlowMilestoneDivisionView

class FlowMilestoneDivisionView extends Object implements Serializable

Serialized Fields

division

WritableDivision division

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.FlowMilestoneDivisionViewEntityListing

class FlowMilestoneDivisionViewEntityListing extends Object implements Serializable

Serialized Fields

entities

List<FlowMilestoneDivisionView> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.FlowMilestoneListing

class FlowMilestoneListing extends Object implements Serializable

Serialized Fields

entities

List<FlowMilestone> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.FlowObservationDataContainer

class FlowObservationDataContainer extends Object implements Serializable

Serialized Fields

data

List<ObservationMetricData> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.FlowObservationQuery

class FlowObservationQuery extends Object implements Serializable

Serialized Fields

detailMetrics

List<FlowObservationQuery.DetailMetricsEnum> detailMetrics

filter

FlowObservationQueryFilter filter

metrics

List<FlowObservationQuery.MetricsEnum> metrics

Class com.mypurecloud.sdk.v2.model.FlowObservationQueryClause

class FlowObservationQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<FlowObservationQueryPredicate> predicates

type

FlowObservationQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.FlowObservationQueryFilter

class FlowObservationQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<FlowObservationQueryClause> clauses

predicates

List<FlowObservationQueryPredicate> predicates

type

FlowObservationQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.FlowObservationQueryPredicate

class FlowObservationQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

FlowObservationQueryPredicate.DimensionEnum dimension

operator

FlowObservationQueryPredicate.OperatorEnum operator

range

NumericRange range

type

FlowObservationQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.FlowObservationQueryResponse

class FlowObservationQueryResponse extends Object implements Serializable

Serialized Fields

results

List<FlowObservationDataContainer> results

Class com.mypurecloud.sdk.v2.model.FlowOutcome

class FlowOutcome extends Object implements Serializable

Serialized Fields

currentOperation

Operation currentOperation

description

String description

division

WritableDivision division

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.FlowOutcomeDivisionView

class FlowOutcomeDivisionView extends Object implements Serializable

Serialized Fields

division

WritableDivision division

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.FlowOutcomeDivisionViewEntityListing

class FlowOutcomeDivisionViewEntityListing extends Object implements Serializable

Serialized Fields

entities

List<FlowOutcomeDivisionView> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.FlowOutcomeListing

class FlowOutcomeListing extends Object implements Serializable

Serialized Fields

entities

List<FlowOutcome> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.FlowResultEntityListing

class FlowResultEntityListing extends Object implements Serializable

Serialized Fields

entities

List<FlowExecutionDataQueryResult> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.FlowRuntimeExecution

class FlowRuntimeExecution extends Object implements Serializable

Serialized Fields

completionReason

String completionReason

conversation

DomainEntityRef conversation

dateCompleted

Date dateCompleted

dateLaunched

Date dateLaunched

flowErrorInfo

ErrorBody flowErrorInfo

flowVersion

FlowVersion flowVersion

id

String id

name

String name

outputData

Map<String,Object> outputData

selfUri

String selfUri

status

FlowRuntimeExecution.StatusEnum status

Class com.mypurecloud.sdk.v2.model.FlowsQueryCriteriaResponse

class FlowsQueryCriteriaResponse extends Object implements Serializable

Serialized Fields

actionTypes

List<FlowsQueryCriteriaResponse.ActionTypesEnum> actionTypes

criteria

List<QueryCriteria> criteria

errorCodes

List<String> errorCodes

flowTypes

List<FlowsQueryCriteriaResponse.FlowTypesEnum> flowTypes

warningCodes

List<String> warningCodes

Class com.mypurecloud.sdk.v2.model.FlowStartDetailEventTopicFlowStartEvent

class FlowStartDetailEventTopicFlowStartEvent extends Object implements Serializable

Serialized Fields

addressFrom

String addressFrom

addressTo

String addressTo

ani

String ani

conversationExternalContactIds

List<String> conversationExternalContactIds

conversationExternalOrganizationIds

List<String> conversationExternalOrganizationIds

conversationId

String conversationId

direction

FlowStartDetailEventTopicFlowStartEvent.DirectionEnum direction

divisionId

String divisionId

dnis

String dnis

eventTime

Integer eventTime

flowId

String flowId

flowType

FlowStartDetailEventTopicFlowStartEvent.FlowTypeEnum flowType

flowVersion

String flowVersion

mediaType

FlowStartDetailEventTopicFlowStartEvent.MediaTypeEnum mediaType

messageType

FlowStartDetailEventTopicFlowStartEvent.MessageTypeEnum messageType

participantId

String participantId

provider

String provider

sessionId

String sessionId

subject

String subject

Class com.mypurecloud.sdk.v2.model.FlowVersion

class FlowVersion extends Object implements Serializable

Serialized Fields

commitVersion

String commitVersion

compatibleFlowTypes

List<FlowVersion.CompatibleFlowTypesEnum> compatibleFlowTypes

configurationUri

String configurationUri

configurationVersion

String configurationVersion

createdBy

User createdBy

createdByClient

DomainEntityRef createdByClient

dateCheckedIn

Long dateCheckedIn

dateCreated

Long dateCreated

datePublished

Date datePublished

datePublishedEnd

Date datePublishedEnd

dateSaved

Long dateSaved

debug

Boolean debug

generationId

String generationId

id

String id

inputSchema

JsonSchemaDocument inputSchema

name

String name

nluInfo

NluInfo nluInfo

outputSchema

JsonSchemaDocument outputSchema

publishResultUri

String publishResultUri

secure

Boolean secure

selfUri

String selfUri

supportedLanguages

List<SupportedLanguage> supportedLanguages

type

FlowVersion.TypeEnum type

Class com.mypurecloud.sdk.v2.model.FlowVersionEntityListing

class FlowVersionEntityListing extends Object implements Serializable

Serialized Fields

entities

List<FlowVersion> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.FooterTemplate

class FooterTemplate extends Object implements Serializable

Serialized Fields

applicableResources

List<FooterTemplate.ApplicableResourcesEnum> applicableResources

type

FooterTemplate.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ForecastAbandonRateResponse

class ForecastAbandonRateResponse extends Object implements Serializable

Serialized Fields

percent

Integer percent

Class com.mypurecloud.sdk.v2.model.ForecastAverageSpeedOfAnswerResponse

class ForecastAverageSpeedOfAnswerResponse extends Object implements Serializable

Serialized Fields

seconds

Integer seconds

Class com.mypurecloud.sdk.v2.model.ForecastPlanningGroupData

class ForecastPlanningGroupData extends Object implements Serializable

Serialized Fields

averageHandleTimeSecondsPerInterval

List<Double> averageHandleTimeSecondsPerInterval

offeredPerInterval

List<Double> offeredPerInterval

planningGroupId

String planningGroupId

Class com.mypurecloud.sdk.v2.model.ForecastPlanningGroupResponse

class ForecastPlanningGroupResponse extends Object implements Serializable

Serialized Fields

id

String id

name

String name

routePaths

List<RoutePathResponse> routePaths

serviceGoalTemplate

ForecastServiceGoalTemplateResponse serviceGoalTemplate

Class com.mypurecloud.sdk.v2.model.ForecastPlanningGroupsResponse

class ForecastPlanningGroupsResponse extends Object implements Serializable

Serialized Fields

entities

List<ForecastPlanningGroupResponse> entities

Class com.mypurecloud.sdk.v2.model.ForecastServiceGoalTemplateImpactOverrideResponse

class ForecastServiceGoalTemplateImpactOverrideResponse extends Object implements Serializable

Serialized Fields

abandonRate

WfmServiceGoalImpact abandonRate

averageSpeedOfAnswer

WfmServiceGoalImpact averageSpeedOfAnswer

serviceLevel

WfmServiceGoalImpact serviceLevel

Class com.mypurecloud.sdk.v2.model.ForecastServiceGoalTemplateResponse

class ForecastServiceGoalTemplateResponse extends Object implements Serializable

Serialized Fields

abandonRate

ForecastAbandonRateResponse abandonRate

averageSpeedOfAnswer

ForecastAverageSpeedOfAnswerResponse averageSpeedOfAnswer

serviceLevel

ForecastServiceLevelResponse serviceLevel

Class com.mypurecloud.sdk.v2.model.ForecastServiceLevelResponse

class ForecastServiceLevelResponse extends Object implements Serializable

Serialized Fields

percent

Integer percent

seconds

Integer seconds

Class com.mypurecloud.sdk.v2.model.ForecastSourceDayPointer

class ForecastSourceDayPointer extends Object implements Serializable

Serialized Fields

dataKey

String dataKey

date

String date

dayOfWeek

ForecastSourceDayPointer.DayOfWeekEnum dayOfWeek

fileName

String fileName

weight

Integer weight

Class com.mypurecloud.sdk.v2.model.Format

class Format extends Object implements Serializable

Serialized Fields

flags

List<Format.FlagsEnum> flags

Class com.mypurecloud.sdk.v2.model.FormsTrackTrigger

class FormsTrackTrigger extends Object implements Serializable

Serialized Fields

captureDataOnFormAbandon

Boolean captureDataOnFormAbandon

captureDataOnFormSubmit

Boolean captureDataOnFormSubmit

formName

String formName

selector

String selector

Class com.mypurecloud.sdk.v2.model.FromEmailAddress

class FromEmailAddress extends Object implements Serializable

Serialized Fields

domain

DomainEntityRef domain

friendlyName

String friendlyName

localPart

String localPart

Class com.mypurecloud.sdk.v2.model.FullDayTimeOffMarker

class FullDayTimeOffMarker extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

businessUnitDate

LocalDate businessUnitDate

description

String description

lengthMinutes

Integer lengthMinutes

paid

Boolean paid

timeOffRequestId

String timeOffRequestId

Class com.mypurecloud.sdk.v2.model.GamificationScorecardChangeTopicMetric

class GamificationScorecardChangeTopicMetric extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.GamificationScorecardChangeTopicPerformanceMetric

class GamificationScorecardChangeTopicPerformanceMetric extends Object implements Serializable

Serialized Fields

metric

GamificationScorecardChangeTopicMetric metric

points

Integer points

punctualityEvents

List<GamificationScorecardChangeTopicPunctualityEvent> punctualityEvents

value

BigDecimal value

Class com.mypurecloud.sdk.v2.model.GamificationScorecardChangeTopicPunctualityEvent

class GamificationScorecardChangeTopicPunctualityEvent extends Object implements Serializable

Serialized Fields

activityCode

String activityCode

dateScheduleStart

String dateScheduleStart

dateStart

String dateStart

points

Integer points

Class com.mypurecloud.sdk.v2.model.GamificationScorecardChangeTopicScorecardChange

class GamificationScorecardChangeTopicScorecardChange extends Object implements Serializable

Serialized Fields

divisionId

String divisionId

performanceMetrics

List<GamificationScorecardChangeTopicPerformanceMetric> performanceMetrics

performanceProfileId

String performanceProfileId

teamId

String teamId

userId

String userId

workday

String workday

Class com.mypurecloud.sdk.v2.model.GamificationStatus

class GamificationStatus extends Object implements Serializable

Serialized Fields

automaticUserAssignment

Boolean automaticUserAssignment

dateStart

LocalDate dateStart

dateStartPersonalBest

LocalDate dateStartPersonalBest

isActive

Boolean isActive

Class com.mypurecloud.sdk.v2.model.GDPRJourneyCustomer

class GDPRJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.GDPRRequest

class GDPRRequest extends Object implements Serializable

Serialized Fields

createdBy

DomainEntityRef createdBy

createdDate

Date createdDate

id

String id

name

String name

replacementTerms

List<ReplacementTerm> replacementTerms

requestType

GDPRRequest.RequestTypeEnum requestType

resultsUrl

String resultsUrl

selfUri

String selfUri

status

GDPRRequest.StatusEnum status

subject

GDPRSubject subject

Class com.mypurecloud.sdk.v2.model.GDPRRequestEntityListing

class GDPRRequestEntityListing extends Object implements Serializable

Serialized Fields

entities

List<GDPRRequest> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.GDPRSubject

class GDPRSubject extends Object implements Serializable

Serialized Fields

addresses

List<String> addresses

dialerContactId

DialerContactId dialerContactId

emailAddresses

List<String> emailAddresses

externalContactId

String externalContactId

externalId

String externalId

journeyCustomer

GDPRJourneyCustomer journeyCustomer

name

String name

phoneNumbers

List<String> phoneNumbers

socialHandle

SocialHandle socialHandle

userId

String userId

Class com.mypurecloud.sdk.v2.model.GDPRSubjectEntityListing

class GDPRSubjectEntityListing extends Object implements Serializable

Serialized Fields

entities

List<GDPRSubject> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.GeneralProgramJob

class GeneralProgramJob extends Object implements Serializable

Serialized Fields

createdBy

AddressableEntityRef createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

selfUri

String selfUri

state

GeneralProgramJob.StateEnum state

Class com.mypurecloud.sdk.v2.model.GeneralProgramJobRequest

class GeneralProgramJobRequest extends Object implements Serializable

Serialized Fields

dialect

GeneralProgramJobRequest.DialectEnum dialect

mode

GeneralProgramJobRequest.ModeEnum mode

Class com.mypurecloud.sdk.v2.model.GeneralTopic

class GeneralTopic extends Object implements Serializable

Serialized Fields

name

String name

Class com.mypurecloud.sdk.v2.model.GeneralTopicsEntityListing

class GeneralTopicsEntityListing extends Object implements Serializable

Serialized Fields

entities

List<GeneralTopic> entities

Class com.mypurecloud.sdk.v2.model.GenerateBuForecastRequest

class GenerateBuForecastRequest extends Object implements Serializable

Serialized Fields

canUseForScheduling

Boolean canUseForScheduling

description

String description

weekCount

Integer weekCount

Class com.mypurecloud.sdk.v2.model.GenericActionEvent

class GenericActionEvent extends Object implements Serializable

Serialized Fields

action

GenericEventAction action

actionMap

ActionEventActionMap actionMap

errorCode

String errorCode

errorMessage

String errorMessage

Class com.mypurecloud.sdk.v2.model.GenericEventAction

class GenericEventAction extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

id

String id

mediaAddress

String mediaAddress

mediaType

GenericEventAction.MediaTypeEnum mediaType

prompt

String prompt

state

GenericEventAction.StateEnum state

Class com.mypurecloud.sdk.v2.model.GenericSAML

class GenericSAML extends Object implements Serializable

Serialized Fields

certificate

String certificate

certificates

List<String> certificates

disabled

Boolean disabled

endpointCompression

Boolean endpointCompression

id

String id

issuerURI

String issuerURI

logoImageData

String logoImageData

name

String name

nameIdentifierFormat

GenericSAML.NameIdentifierFormatEnum nameIdentifierFormat

relyingPartyIdentifier

String relyingPartyIdentifier

selfUri

String selfUri

sloBinding

String sloBinding

sloURI

String sloURI

ssoTargetURI

String ssoTargetURI

Class com.mypurecloud.sdk.v2.model.GenericTemplate

class GenericTemplate extends Object implements Serializable

Serialized Fields

actions

RecordingContentActions actions

components

List<RecordingButtonComponent> components

description

String description

title

String title

url

String url

Class com.mypurecloud.sdk.v2.model.GenesysBotConnector

class GenesysBotConnector extends Object implements Serializable

Serialized Fields

queryParameters

Map<String,String> queryParameters

Class com.mypurecloud.sdk.v2.model.Geolocation

class Geolocation extends Object implements Serializable

Serialized Fields

city

String city

country

String country

id

String id

latitude

Double latitude

locations

List<LocationDefinition> locations

longitude

Double longitude

name

String name

primary

Boolean primary

region

String region

selfUri

String selfUri

type

String type

Class com.mypurecloud.sdk.v2.model.GeolocationEventGeolocation

class GeolocationEventGeolocation extends Object implements Serializable

Serialized Fields

city

String city

country

String country

region

String region

type

String type

userId

String userId

Class com.mypurecloud.sdk.v2.model.GeolocationSettings

class GeolocationSettings extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

id

String id

mapboxKey

String mapboxKey

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.GetFlowExecutionDataJobResult

class GetFlowExecutionDataJobResult extends Object implements Serializable

Serialized Fields

entities

List<ExecutionDataEntity> entities

id

String id

jobState

GetFlowExecutionDataJobResult.JobStateEnum jobState

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.GetMetricDefinitionsResponse

class GetMetricDefinitionsResponse extends Object implements Serializable

Serialized Fields

entities

List<MetricDefinition> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.GetMetricResponse

class GetMetricResponse extends Object implements Serializable

Serialized Fields

entities

List<Metric> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.GetMetricsResponse

class GetMetricsResponse extends Object implements Serializable

Serialized Fields

entities

List<Metrics> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.GetProfilesResponse

class GetProfilesResponse extends Object implements Serializable

Serialized Fields

entities

List<PerformanceProfile> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.GetTemplatesResponse

class GetTemplatesResponse extends Object implements Serializable

Serialized Fields

entities

List<ObjectiveTemplate> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.GKNDocumentationResult

class GKNDocumentationResult extends Object implements Serializable

Serialized Fields

content

String content

link

String link

title

String title

type

String type

Class com.mypurecloud.sdk.v2.model.GKNDocumentationSearchCriteria

class GKNDocumentationSearchCriteria extends Object implements Serializable

Serialized Fields

dateFormat

String dateFormat

endValue

String endValue

fields

List<String> fields

group

List<GKNDocumentationSearchCriteria> group

operator

GKNDocumentationSearchCriteria.OperatorEnum operator

startValue

String startValue

type

GKNDocumentationSearchCriteria.TypeEnum type

value

String value

values

List<String> values

Class com.mypurecloud.sdk.v2.model.GKNDocumentationSearchRequest

class GKNDocumentationSearchRequest extends Object implements Serializable

Serialized Fields

pageNumber

Integer pageNumber

pageSize

Integer pageSize

query

List<GKNDocumentationSearchCriteria> query

sort

List<SearchSort> sort

sortBy

String sortBy

sortOrder

GKNDocumentationSearchRequest.SortOrderEnum sortOrder

Class com.mypurecloud.sdk.v2.model.GKNDocumentationSearchResponse

class GKNDocumentationSearchResponse extends Object implements Serializable

Serialized Fields

currentPage

String currentPage

nextPage

String nextPage

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousPage

String previousPage

results

List<GKNDocumentationResult> results

total

Long total

types

List<String> types

Class com.mypurecloud.sdk.v2.model.GoogleDialogflowCustomSettings

class GoogleDialogflowCustomSettings extends Object implements Serializable

Serialized Fields

environment

String environment

eventInputParameters

Map<String,String> eventInputParameters

eventName

String eventName

webhookQueryParameters

Map<String,String> webhookQueryParameters

Class com.mypurecloud.sdk.v2.model.Greeting

class Greeting extends Object implements Serializable

Serialized Fields

audioFile

GreetingAudioFile audioFile

audioTTS

String audioTTS

createdBy

String createdBy

createdDate

Date createdDate

id

String id

modifiedBy

String modifiedBy

modifiedDate

Date modifiedDate

name

String name

owner

DomainEntity owner

ownerType

Greeting.OwnerTypeEnum ownerType

selfUri

String selfUri

type

Greeting.TypeEnum type

Class com.mypurecloud.sdk.v2.model.GreetingAudioFile

class GreetingAudioFile extends Object implements Serializable

Serialized Fields

durationMilliseconds

Long durationMilliseconds

selfUri

String selfUri

sizeBytes

Long sizeBytes

Class com.mypurecloud.sdk.v2.model.GreetingListing

class GreetingListing extends Object implements Serializable

Serialized Fields

entities

List<Greeting> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.GreetingMediaInfo

class GreetingMediaInfo extends Object implements Serializable

Serialized Fields

id

String id

mediaFileUri

String mediaFileUri

mediaImageUri

String mediaImageUri

Class com.mypurecloud.sdk.v2.model.GreetingOwner

class GreetingOwner extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.Group

class Group extends Object implements Serializable

Serialized Fields

addresses

List<GroupContact> addresses

dateModified

Date dateModified

description

String description

id

String id

images

List<UserImage> images

memberCount

Long memberCount

name

String name

owners

List<User> owners

rulesVisible

Boolean rulesVisible

selfUri

String selfUri

state

Group.StateEnum state

type

Group.TypeEnum type

version

Integer version

visibility

Group.VisibilityEnum visibility

Class com.mypurecloud.sdk.v2.model.GroupContact

class GroupContact extends Object implements Serializable

Serialized Fields

address

String address

display

String display

extension

String extension

mediaType

GroupContact.MediaTypeEnum mediaType

type

GroupContact.TypeEnum type

Class com.mypurecloud.sdk.v2.model.GroupCreate

class GroupCreate extends Object implements Serializable

Serialized Fields

addresses

List<GroupContact> addresses

dateModified

Date dateModified

description

String description

id

String id

images

List<UserImage> images

memberCount

Long memberCount

name

String name

ownerIds

List<String> ownerIds

rulesVisible

Boolean rulesVisible

selfUri

String selfUri

state

GroupCreate.StateEnum state

type

GroupCreate.TypeEnum type

version

Integer version

visibility

GroupCreate.VisibilityEnum visibility

Class com.mypurecloud.sdk.v2.model.GroupEntityListing

class GroupEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Group> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.GroupGreetingEventGreeting

class GroupGreetingEventGreeting extends Object implements Serializable

Serialized Fields

audioTTS

String audioTTS

greetingAudioFile

GroupGreetingEventGreetingAudioFile greetingAudioFile

id

String id

name

String name

owner

GroupGreetingEventGreetingOwner owner

ownerType

String ownerType

type

String type

Class com.mypurecloud.sdk.v2.model.GroupGreetingEventGreetingAudioFile

class GroupGreetingEventGreetingAudioFile extends Object implements Serializable

Serialized Fields

durationMilliseconds

Integer durationMilliseconds

sizeBytes

Integer sizeBytes

Class com.mypurecloud.sdk.v2.model.GroupGreetingEventGreetingOwner

class GroupGreetingEventGreetingOwner extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.GroupMembersUpdate

class GroupMembersUpdate extends Object implements Serializable

Serialized Fields

memberIds

List<String> memberIds

version

Integer version

Class com.mypurecloud.sdk.v2.model.GroupProfile

class GroupProfile extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

id

String id

name

String name

selfUri

String selfUri

state

GroupProfile.StateEnum state

version

Long version

Class com.mypurecloud.sdk.v2.model.GroupProfileEntityListing

class GroupProfileEntityListing extends Object implements Serializable

Serialized Fields

entities

List<GroupProfile> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.GroupSearchCriteria

class GroupSearchCriteria extends Object implements Serializable

Serialized Fields

dateFormat

String dateFormat

endValue

String endValue

fields

List<String> fields

group

List<GroupSearchCriteria> group

operator

GroupSearchCriteria.OperatorEnum operator

startValue

String startValue

type

GroupSearchCriteria.TypeEnum type

value

String value

values

List<String> values

Class com.mypurecloud.sdk.v2.model.GroupSearchRequest

class GroupSearchRequest extends Object implements Serializable

Serialized Fields

pageNumber

Integer pageNumber

pageSize

Integer pageSize

query

List<GroupSearchCriteria> query

sort

List<SearchSort> sort

sortBy

String sortBy

sortOrder

GroupSearchRequest.SortOrderEnum sortOrder

Class com.mypurecloud.sdk.v2.model.GroupsSearchResponse

class GroupsSearchResponse extends Object implements Serializable

Serialized Fields

currentPage

String currentPage

nextPage

String nextPage

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousPage

String previousPage

results

List<Group> results

total

Long total

types

List<String> types

Class com.mypurecloud.sdk.v2.model.GroupUpdate

class GroupUpdate extends Object implements Serializable

Serialized Fields

addresses

List<GroupContact> addresses

description

String description

id

String id

images

List<UserImage> images

name

String name

ownerIds

List<String> ownerIds

rulesVisible

Boolean rulesVisible

selfUri

String selfUri

state

GroupUpdate.StateEnum state

version

Integer version

visibility

GroupUpdate.VisibilityEnum visibility

Class com.mypurecloud.sdk.v2.model.GSuite

class GSuite extends Object implements Serializable

Serialized Fields

certificate

String certificate

certificates

List<String> certificates

disabled

Boolean disabled

id

String id

issuerURI

String issuerURI

name

String name

relyingPartyIdentifier

String relyingPartyIdentifier

selfUri

String selfUri

sloBinding

String sloBinding

sloURI

String sloURI

ssoTargetURI

String ssoTargetURI

Class com.mypurecloud.sdk.v2.model.GuestCategoryReference

class GuestCategoryReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.GuestCategoryResponse

class GuestCategoryResponse extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

id

String id

name

String name

parentCategory

GuestCategoryReference parentCategory

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.GuestCategoryResponseListing

class GuestCategoryResponseListing extends Object implements Serializable

Serialized Fields

entities

List<GuestCategoryResponse> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

sessionId

String sessionId

Class com.mypurecloud.sdk.v2.model.GuestMemberInfo

class GuestMemberInfo extends Object implements Serializable

Serialized Fields

avatarImageUrl

String avatarImageUrl

customFields

Map<String,String> customFields

displayName

String displayName

email

String email

firstName

String firstName

lastName

String lastName

phoneNumber

String phoneNumber

Class com.mypurecloud.sdk.v2.model.HeadcountForecast

class HeadcountForecast extends Object implements Serializable

Serialized Fields

required

List<HeadcountInterval> required

requiredWithoutShrinkage

List<HeadcountInterval> requiredWithoutShrinkage

Class com.mypurecloud.sdk.v2.model.HeadcountInterval

class HeadcountInterval extends Object implements Serializable

Serialized Fields

interval

Date interval

value

Double value

Class com.mypurecloud.sdk.v2.model.HelpLink

class HelpLink extends Object implements Serializable

Serialized Fields

description

String description

title

String title

uri

String uri

Class com.mypurecloud.sdk.v2.model.HelpSettings

class HelpSettings extends Object implements Serializable

Serialized Fields

keyword

List<String> keyword

response

ComplianceResponse response

Class com.mypurecloud.sdk.v2.model.HistoricalAdherenceActuals

class HistoricalAdherenceActuals extends Object implements Serializable

Serialized Fields

actualActivityCategory

HistoricalAdherenceActuals.ActualActivityCategoryEnum actualActivityCategory

actualSecondaryPresenceLookupId

String actualSecondaryPresenceLookupId

endOffsetSeconds

Integer endOffsetSeconds

startOffsetSeconds

Integer startOffsetSeconds

Class com.mypurecloud.sdk.v2.model.HistoricalAdherenceDayMetrics

class HistoricalAdherenceDayMetrics extends Object implements Serializable

Serialized Fields

actualLengthSecs

Integer actualLengthSecs

adherencePercentage

Double adherencePercentage

adherenceScheduleSecs

Integer adherenceScheduleSecs

conformanceActualSecs

Integer conformanceActualSecs

conformancePercentage

Double conformancePercentage

conformanceScheduleSecs

Integer conformanceScheduleSecs

dayStartOffsetSecs

Integer dayStartOffsetSecs

exceptionCount

Integer exceptionCount

exceptionDurationSecs

Integer exceptionDurationSecs

impactSeconds

Integer impactSeconds

scheduleLengthSecs

Integer scheduleLengthSecs

Class com.mypurecloud.sdk.v2.model.HistoricalAdherenceExceptionInfo

class HistoricalAdherenceExceptionInfo extends Object implements Serializable

Serialized Fields

actualActivityCategory

HistoricalAdherenceExceptionInfo.ActualActivityCategoryEnum actualActivityCategory

actualActivityCodeId

String actualActivityCodeId

endOffsetSeconds

Integer endOffsetSeconds

impact

HistoricalAdherenceExceptionInfo.ImpactEnum impact

routingStatus

HistoricalAdherenceExceptionInfo.RoutingStatusEnum routingStatus

scheduledActivityCategory

HistoricalAdherenceExceptionInfo.ScheduledActivityCategoryEnum scheduledActivityCategory

scheduledActivityCodeId

String scheduledActivityCodeId

scheduledSecondaryPresenceLookupIds

List<String> scheduledSecondaryPresenceLookupIds

secondaryPresenceLookupId

String secondaryPresenceLookupId

startOffsetSeconds

Integer startOffsetSeconds

systemPresence

HistoricalAdherenceExceptionInfo.SystemPresenceEnum systemPresence

Class com.mypurecloud.sdk.v2.model.HistoricalAdherenceQueryResult

class HistoricalAdherenceQueryResult extends Object implements Serializable

Serialized Fields

actuals

List<HistoricalAdherenceActuals> actuals

actualsEndDate

Date actualsEndDate

adherencePercentage

Double adherencePercentage

conformancePercentage

Double conformancePercentage

dayMetrics

List<HistoricalAdherenceDayMetrics> dayMetrics

endDate

Date endDate

exceptionInfo

List<HistoricalAdherenceExceptionInfo> exceptionInfo

impact

HistoricalAdherenceQueryResult.ImpactEnum impact

managementUnitId

String managementUnitId

startDate

Date startDate

userId

String userId

Class com.mypurecloud.sdk.v2.model.HistoricalImportDeleteJobResponse

class HistoricalImportDeleteJobResponse extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

status

HistoricalImportDeleteJobResponse.StatusEnum status

Class com.mypurecloud.sdk.v2.model.HistoricalImportStatus

class HistoricalImportStatus extends Object implements Serializable

Serialized Fields

active

Boolean active

dateCreated

Date dateCreated

dateImportEnded

Date dateImportEnded

dateImportStarted

Date dateImportStarted

dateModified

Date dateModified

error

String error

requestId

String requestId

status

HistoricalImportStatus.StatusEnum status

type

HistoricalImportStatus.TypeEnum type

Class com.mypurecloud.sdk.v2.model.HistoricalImportStatusListing

class HistoricalImportStatusListing extends Object implements Serializable

Serialized Fields

entities

List<HistoricalImportStatus> entities

Class com.mypurecloud.sdk.v2.model.HistoricalShrinkageActivityCategoryResponse

class HistoricalShrinkageActivityCategoryResponse extends Object implements Serializable

Serialized Fields

activityCategory

HistoricalShrinkageActivityCategoryResponse.ActivityCategoryEnum activityCategory

shrinkageForActivityCategory

HistoricalShrinkageAggregateResponse shrinkageForActivityCategory

shrinkageForActivityCodes

List<HistoricalShrinkageActivityCodeResponse> shrinkageForActivityCodes

Class com.mypurecloud.sdk.v2.model.HistoricalShrinkageActivityCodeResponse

class HistoricalShrinkageActivityCodeResponse extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

shrinkageForActivityCode

HistoricalShrinkageAggregateResponse shrinkageForActivityCode

Class com.mypurecloud.sdk.v2.model.HistoricalShrinkageAggregateResponse

class HistoricalShrinkageAggregateResponse extends Object implements Serializable

Serialized Fields

actualShrinkagePercent

Double actualShrinkagePercent

actualShrinkageSeconds

Integer actualShrinkageSeconds

paidShrinkageSeconds

Integer paidShrinkageSeconds

plannedShrinkageSeconds

Integer plannedShrinkageSeconds

scheduledShrinkagePercent

Double scheduledShrinkagePercent

scheduledShrinkageSeconds

Integer scheduledShrinkageSeconds

unpaidShrinkageSeconds

Integer unpaidShrinkageSeconds

unplannedShrinkageSeconds

Integer unplannedShrinkageSeconds

Class com.mypurecloud.sdk.v2.model.HistoricalShrinkageResult

class HistoricalShrinkageResult extends Object implements Serializable

Serialized Fields

aggregatedShrinkage

HistoricalShrinkageAggregateResponse aggregatedShrinkage

businessUnitIds

List<String> businessUnitIds

endDate

Date endDate

shrinkageForActivityCategories

List<HistoricalShrinkageActivityCategoryResponse> shrinkageForActivityCategories

startDate

Date startDate

totalLoggedInDurationSeconds

Integer totalLoggedInDurationSeconds

totalScheduledDurationSeconds

Integer totalScheduledDurationSeconds

Class com.mypurecloud.sdk.v2.model.HistoricalShrinkageResultListing

class HistoricalShrinkageResultListing extends Object implements Serializable

Serialized Fields

entities

List<HistoricalShrinkageResult> entities

Class com.mypurecloud.sdk.v2.model.HistoryEntry

class HistoryEntry extends Object implements Serializable

Serialized Fields

action

HistoryEntry.ActionEnum action

client

DomainEntityRef client

resource

String resource

secure

Boolean secure

timestamp

Date timestamp

user

User user

version

String version

Class com.mypurecloud.sdk.v2.model.HistoryHeadersTranslation

class HistoryHeadersTranslation extends Object implements Serializable

Serialized Fields

cc

String cc

forwardPrefix

String forwardPrefix

from

String from

language

String language

replyPrefix

String replyPrefix

sent

String sent

subject

String subject

timeZone

String timeZone

to

String to

Class com.mypurecloud.sdk.v2.model.HistoryListing

class HistoryListing extends Object implements Serializable

Serialized Fields

actionName

HistoryListing.ActionNameEnum actionName

actionStatus

HistoryListing.ActionStatusEnum actionStatus

client

DomainEntityRef client

complete

Boolean complete

completed

Date completed

description

String description

entities

List<HistoryEntry> entities

errorCode

String errorCode

errorDetails

List<Detail> errorDetails

errorMessage

String errorMessage

errorMessageParams

Map<String,String> errorMessageParams

id

String id

name

String name

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

started

Date started

system

Boolean system

total

Long total

user

User user

Class com.mypurecloud.sdk.v2.model.HoldUpdatedEvent

class HoldUpdatedEvent extends Object implements Serializable

Serialized Fields

communicationId

String communicationId

conversationId

String conversationId

eventDateTime

Date eventDateTime

eventId

String eventId

held

Boolean held

Class com.mypurecloud.sdk.v2.model.HomerRecord

class HomerRecord extends Object implements Serializable

Serialized Fields

auth

String auth

authUser

String authUser

callid

String callid

callidAleg

String callidAleg

contactIp

String contactIp

contactPort

String contactPort

contactUser

String contactUser

contentType

String contentType

conversationId

String conversationId

correlationId

String correlationId

cseq

String cseq

date

Date date

dbnode

String dbnode

destinationAlias

String destinationAlias

destinationIp

String destinationIp

destinationPort

String destinationPort

diversion

String diversion

family

String family

fromDomain

String fromDomain

fromTag

String fromTag

fromUser

String fromUser

id

String id

method

String method

microTs

String microTs

milliTs

String milliTs

msg

String msg

name

String name

node

String node

originatorIp

String originatorIp

originatorPort

String originatorPort

participantId

String participantId

pidUser

String pidUser

proto

String proto

reason

String reason

replyReason

String replyReason

rtpStat

String rtpStat

ruri

String ruri

ruriDomain

String ruriDomain

ruriUser

String ruriUser

selfUri

String selfUri

sourceAlias

String sourceAlias

sourceIp

String sourceIp

sourcePort

String sourcePort

toDomain

String toDomain

toTag

String toTag

toUser

String toUser

trans

String trans

type

String type

userAgent

String userAgent

via1

String via1

via1Branch

String via1Branch

Class com.mypurecloud.sdk.v2.model.HrisTimeOffType

class HrisTimeOffType extends Object implements Serializable

Serialized Fields

hrisIntegrationId

String hrisIntegrationId

id

String id

name

String name

secondaryId

String secondaryId

Class com.mypurecloud.sdk.v2.model.Humanize

class Humanize extends Object implements Serializable

Serialized Fields

bot

BotMessengerProfile bot

enabled

Boolean enabled

Class com.mypurecloud.sdk.v2.model.IdentifierClaimRequest

class IdentifierClaimRequest extends Object implements Serializable

Serialized Fields

identifier

ContactIdentifier identifier

operation

IdentifierClaimRequest.OperationEnum operation

Class com.mypurecloud.sdk.v2.model.IdentityNow

class IdentityNow extends Object implements Serializable

Serialized Fields

certificate

String certificate

certificates

List<String> certificates

disabled

Boolean disabled

id

String id

issuerURI

String issuerURI

name

String name

relyingPartyIdentifier

String relyingPartyIdentifier

selfUri

String selfUri

sloBinding

String sloBinding

sloURI

String sloURI

ssoTargetURI

String ssoTargetURI

Class com.mypurecloud.sdk.v2.model.IdleEventTrigger

class IdleEventTrigger extends Object implements Serializable

Serialized Fields

eventName

String eventName

idleAfterSeconds

Long idleAfterSeconds

Class com.mypurecloud.sdk.v2.model.IdleTokenTimeout

class IdleTokenTimeout extends Object implements Serializable

Serialized Fields

enableIdleTokenTimeout

Boolean enableIdleTokenTimeout

idleTokenTimeoutSeconds

Integer idleTokenTimeoutSeconds

Class com.mypurecloud.sdk.v2.model.IgnoredActivityCategories

class IgnoredActivityCategories extends Object implements Serializable

Serialized Fields

values

List<IgnoredActivityCategories.ValuesEnum> values

Class com.mypurecloud.sdk.v2.model.ImportError

class ImportError extends Object implements Serializable

Serialized Fields

line

Integer line

message

String message

Class com.mypurecloud.sdk.v2.model.ImportForecastResponse

class ImportForecastResponse extends Object implements Serializable

Serialized Fields

operationId

String operationId

result

BuShortTermForecast result

status

ImportForecastResponse.StatusEnum status

Class com.mypurecloud.sdk.v2.model.ImportForecastUploadResponse

class ImportForecastUploadResponse extends Object implements Serializable

Serialized Fields

headers

Map<String,String> headers

uploadBodySchema

BuImportShortTermForecastSchema uploadBodySchema

uploadKey

String uploadKey

url

String url

Class com.mypurecloud.sdk.v2.model.ImportReport

class ImportReport extends Object implements Serializable

Serialized Fields

errors

List<ImportError> errors

imported

ResultCounters imported

totalDocuments

Integer totalDocuments

validated

ResultCounters validated

Class com.mypurecloud.sdk.v2.model.ImportScheduleUploadResponse

class ImportScheduleUploadResponse extends Object implements Serializable

Serialized Fields

headers

Map<String,String> headers

uploadBodySchema

ImportScheduleUploadSchema uploadBodySchema

uploadKey

String uploadKey

url

String url

Class com.mypurecloud.sdk.v2.model.ImportScheduleUploadSchema

class ImportScheduleUploadSchema extends Object implements Serializable

Serialized Fields

agentSchedules

List<BuImportAgentScheduleUploadSchema> agentSchedules

description

String description

headcountForecast

BuHeadcountForecast headcountForecast

published

Boolean published

shortTermForecast

BuShortTermForecastReference shortTermForecast

weekCount

Integer weekCount

Class com.mypurecloud.sdk.v2.model.ImportScriptStatusResponse

class ImportScriptStatusResponse extends Object implements Serializable

Serialized Fields

message

String message

succeeded

Boolean succeeded

url

String url

Class com.mypurecloud.sdk.v2.model.ImportStatus

class ImportStatus extends Object implements Serializable

Serialized Fields

completedRecords

Long completedRecords

failureReason

String failureReason

percentComplete

Integer percentComplete

state

ImportStatus.StateEnum state

totalRecords

Long totalRecords

Class com.mypurecloud.sdk.v2.model.ImportStatusRequest

class ImportStatusRequest extends Object implements Serializable

Serialized Fields

status

String status

Class com.mypurecloud.sdk.v2.model.InboundDomain

class InboundDomain extends Object implements Serializable

Serialized Fields

customSMTPServer

DomainEntityRef customSMTPServer

id

String id

mailFromSettings

MailFromResult mailFromSettings

mxRecordStatus

InboundDomain.MxRecordStatusEnum mxRecordStatus

name

String name

selfUri

String selfUri

subDomain

Boolean subDomain

Class com.mypurecloud.sdk.v2.model.InboundDomainEntityListing

class InboundDomainEntityListing extends Object implements Serializable

Serialized Fields

entities

List<InboundDomain> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.InboundDomainPatchRequest

class InboundDomainPatchRequest extends Object implements Serializable

Serialized Fields

customSMTPServer

DomainEntityRef customSMTPServer

mailFromSettings

MailFromResult mailFromSettings

Class com.mypurecloud.sdk.v2.model.InboundMessageRequest

class InboundMessageRequest extends Object implements Serializable

Serialized Fields

attributes

Map<String,String> attributes

flowId

String flowId

fromAddress

String fromAddress

fromName

String fromName

languageId

String languageId

priority

Integer priority

provider

String provider

queueId

String queueId

skillIds

List<String> skillIds

subject

String subject

toAddress

String toAddress

toName

String toName

Class com.mypurecloud.sdk.v2.model.InboundOnlySetting

class InboundOnlySetting extends Object implements Serializable

Serialized Fields

inbound

InboundOnlySetting.InboundEnum inbound

Class com.mypurecloud.sdk.v2.model.InboundRoute

class InboundRoute extends Object implements Serializable

Serialized Fields

allowMultipleActions

Boolean allowMultipleActions

autoBcc

List<EmailAddress> autoBcc

flow

DomainEntityRef flow

fromEmail

String fromEmail

fromName

String fromName

historyInclusion

InboundRoute.HistoryInclusionEnum historyInclusion

id

String id

language

DomainEntityRef language

name

String name

pattern

String pattern

priority

Integer priority

queue

DomainEntityRef queue

replyEmailAddress

QueueEmailAddress replyEmailAddress

selfUri

String selfUri

signature

Signature signature

skills

List<DomainEntityRef> skills

spamFlow

DomainEntityRef spamFlow

Class com.mypurecloud.sdk.v2.model.InboundRouteEntityListing

class InboundRouteEntityListing extends Object implements Serializable

Serialized Fields

entities

List<InboundRoute> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.InfrastructureascodeJob

class InfrastructureascodeJob extends Object implements Serializable

Serialized Fields

acceleratorId

String acceleratorId

dateSubmitted

Date dateSubmitted

dryRun

Boolean dryRun

errorInfo

ErrorInfo errorInfo

id

String id

results

String results

selfUri

String selfUri

status

InfrastructureascodeJob.StatusEnum status

submittedBy

UserReference submittedBy

Class com.mypurecloud.sdk.v2.model.InitialConfiguration

class InitialConfiguration extends Object implements Serializable

Serialized Fields

additionalInfo

Map<String,String> additionalInfo

alerting

Boolean alerting

audioState

AudioState audioState

inbound

Boolean inbound

invitedBy

String invitedBy

recordingActive

Boolean recordingActive

Class com.mypurecloud.sdk.v2.model.InitiateScreenRecording

class InitiateScreenRecording extends Object implements Serializable

Serialized Fields

archiveRetention

ArchiveRetention archiveRetention

deleteRetention

DeleteRetention deleteRetention

recordACW

Boolean recordACW

Class com.mypurecloud.sdk.v2.model.InitiatingAction

class InitiatingAction extends Object implements Serializable

Serialized Fields

actionContext

String actionContext

transactionId

String transactionId

Class com.mypurecloud.sdk.v2.model.InsightsAgentItem

class InsightsAgentItem extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.InsightsAgents

class InsightsAgents extends Object implements Serializable

Serialized Fields

dateEndWorkday

LocalDate dateEndWorkday

dateStartWorkday

LocalDate dateStartWorkday

division

DivisionReference division

entities

List<InsightsAgentItem> entities

granularity

InsightsAgents.GranularityEnum granularity

performanceProfile

AddressableEntityRef performanceProfile

Class com.mypurecloud.sdk.v2.model.InsightsDetails

class InsightsDetails extends Object implements Serializable

Serialized Fields

comparativePeriod

WorkdayPeriod comparativePeriod

division

DivisionReference division

granularity

InsightsDetails.GranularityEnum granularity

metricData

List<InsightsDetailsMetricItem> metricData

overallData

InsightsDetailsOverallItem overallData

performanceProfile

AddressableEntityRef performanceProfile

primaryPeriod

WorkdayPeriod primaryPeriod

user

UserReference user

Class com.mypurecloud.sdk.v2.model.InsightsDetailsMetricItem

class InsightsDetailsMetricItem extends Object implements Serializable

Serialized Fields

comparativePeriod

InsightsDetailsMetricPeriodPoints comparativePeriod

metric

AddressableEntityRef metric

percentOfGoalChange

Double percentOfGoalChange

primaryPeriod

InsightsDetailsMetricPeriodPoints primaryPeriod

valueChange

Double valueChange

Class com.mypurecloud.sdk.v2.model.InsightsDetailsMetricPeriodPoints

class InsightsDetailsMetricPeriodPoints extends Object implements Serializable

Serialized Fields

dataPointCount

Integer dataPointCount

maxPoints

Integer maxPoints

percentOfGoal

Double percentOfGoal

points

Integer points

rankPercentagePoints

Integer rankPercentagePoints

rankTotalPoints

Integer rankTotalPoints

value

Double value

Class com.mypurecloud.sdk.v2.model.InsightsDetailsOverallItem

class InsightsDetailsOverallItem extends Object implements Serializable

Serialized Fields

comparativePeriod

InsightsDetailsOverallPeriodPoints comparativePeriod

percentOfGoalChange

Double percentOfGoalChange

primaryPeriod

InsightsDetailsOverallPeriodPoints primaryPeriod

Class com.mypurecloud.sdk.v2.model.InsightsDetailsOverallPeriodPoints

class InsightsDetailsOverallPeriodPoints extends Object implements Serializable

Serialized Fields

dataPointCount

Integer dataPointCount

maxPoints

Integer maxPoints

percentOfGoal

Double percentOfGoal

points

Integer points

rankPercentagePoints

Integer rankPercentagePoints

rankTotalPoints

Integer rankTotalPoints

Class com.mypurecloud.sdk.v2.model.InsightsSummary

class InsightsSummary extends Object implements Serializable

Serialized Fields

comparativePeriod

WorkdayPeriod comparativePeriod

division

DivisionReference division

entities

List<InsightsSummaryUserItem> entities

granularity

InsightsSummary.GranularityEnum granularity

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

performanceProfile

AddressableEntityRef performanceProfile

primaryPeriod

WorkdayPeriod primaryPeriod

total

Long total

Class com.mypurecloud.sdk.v2.model.InsightsSummaryMetricItem

class InsightsSummaryMetricItem extends Object implements Serializable

Serialized Fields

comparativePeriod

InsightsSummaryMetricPeriodPoints comparativePeriod

metric

AddressableEntityRef metric

percentOfGoalChange

Double percentOfGoalChange

primaryPeriod

InsightsSummaryMetricPeriodPoints primaryPeriod

valueChange

Double valueChange

Class com.mypurecloud.sdk.v2.model.InsightsSummaryMetricPeriodPoints

class InsightsSummaryMetricPeriodPoints extends Object implements Serializable

Serialized Fields

dataPointCount

Integer dataPointCount

maxPoints

Integer maxPoints

percentOfGoal

Double percentOfGoal

points

Integer points

value

Double value

Class com.mypurecloud.sdk.v2.model.InsightsSummaryOverallItem

class InsightsSummaryOverallItem extends Object implements Serializable

Serialized Fields

comparativePeriod

InsightsSummaryOverallPeriodPoints comparativePeriod

percentOfGoalChange

Double percentOfGoalChange

primaryPeriod

InsightsSummaryOverallPeriodPoints primaryPeriod

Class com.mypurecloud.sdk.v2.model.InsightsSummaryOverallPeriodPoints

class InsightsSummaryOverallPeriodPoints extends Object implements Serializable

Serialized Fields

dataPointCount

Integer dataPointCount

maxPoints

Integer maxPoints

percentOfGoal

Double percentOfGoal

points

Integer points

Class com.mypurecloud.sdk.v2.model.InsightsSummaryUserItem

class InsightsSummaryUserItem extends Object implements Serializable

Serialized Fields

metricData

List<InsightsSummaryMetricItem> metricData

overallData

InsightsSummaryOverallItem overallData

user

UserReference user

Class com.mypurecloud.sdk.v2.model.InsightsTrend

class InsightsTrend extends Object implements Serializable

Serialized Fields

comparativePeriod

WorkdayPeriod comparativePeriod

division

DivisionReference division

entities

List<InsightsTrendMetricItem> entities

granularity

InsightsTrend.GranularityEnum granularity

performanceProfile

AddressableEntityRef performanceProfile

primaryPeriod

WorkdayPeriod primaryPeriod

total

InsightsTrendTotalItem total

Class com.mypurecloud.sdk.v2.model.InsightsTrendMetricItem

class InsightsTrendMetricItem extends Object implements Serializable

Serialized Fields

metric

AddressableEntityRef metric

trends

InsightsTrends trends

Class com.mypurecloud.sdk.v2.model.InsightsTrends

class InsightsTrends extends Object implements Serializable

Serialized Fields

comparativePeriod

List<TrendData> comparativePeriod

primaryPeriod

List<TrendData> primaryPeriod

Class com.mypurecloud.sdk.v2.model.InsightsTrendTotalItem

class InsightsTrendTotalItem extends Object implements Serializable

Serialized Fields

trends

InsightsTrends trends

Class com.mypurecloud.sdk.v2.model.InstagramId

class InstagramId extends Object implements Serializable

Serialized Fields

displayName

String displayName

ids

List<InstagramScopedId> ids

Class com.mypurecloud.sdk.v2.model.InstagramScopedId

class InstagramScopedId extends Object implements Serializable

Serialized Fields

scopedId

String scopedId

Class com.mypurecloud.sdk.v2.model.Integration

class Integration extends Object implements Serializable

Serialized Fields

attributes

Map<String,String> attributes

config

IntegrationConfigurationInfo config

id

String id

integrationType

IntegrationType integrationType

intendedState

Integration.IntendedStateEnum intendedState

name

String name

notes

String notes

reportedState

IntegrationStatusInfo reportedState

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.IntegrationAction

class IntegrationAction extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.IntegrationActionFields

class IntegrationActionFields extends Object implements Serializable

Serialized Fields

integrationAction

IntegrationAction integrationAction

requestMappings

List<RequestMapping> requestMappings

Class com.mypurecloud.sdk.v2.model.IntegrationConfiguration

class IntegrationConfiguration extends Object implements Serializable

Serialized Fields

advanced

Object advanced

credentials

Map<String,CredentialInfo> credentials

id

String id

name

String name

notes

String notes

properties

Object properties

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.IntegrationConfigurationInfo

class IntegrationConfigurationInfo extends Object implements Serializable

Serialized Fields

current

IntegrationConfiguration current

Class com.mypurecloud.sdk.v2.model.IntegrationEntityListing

class IntegrationEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Integration> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.IntegrationExport

class IntegrationExport extends Object implements Serializable

Serialized Fields

integration

DomainEntityRef integration

shouldExportScreenRecordings

Boolean shouldExportScreenRecordings

Class com.mypurecloud.sdk.v2.model.IntegrationStatusInfo

class IntegrationStatusInfo extends Object implements Serializable

Serialized Fields

code

IntegrationStatusInfo.CodeEnum code

detail

MessageInfo detail

effective

String effective

lastUpdated

Date lastUpdated

Class com.mypurecloud.sdk.v2.model.IntegrationType

class IntegrationType extends Object implements Serializable

Serialized Fields

category

String category

configAdvancedSchemaUri

String configAdvancedSchemaUri

configPropertiesSchemaUri

String configPropertiesSchemaUri

credentials

Map<String,CredentialSpecification> credentials

description

String description

faqUri

String faqUri

helpLinks

List<HelpLink> helpLinks

helpUri

String helpUri

id

String id

images

List<UserImage> images

marketplaceUri

String marketplaceUri

maxInstances

Integer maxInstances

name

String name

nonInstallable

Boolean nonInstallable

privacyPolicyUri

String privacyPolicyUri

provider

String provider

salesContactUri

String salesContactUri

selfUri

String selfUri

supportContactUri

String supportContactUri

termsOfServiceUri

String termsOfServiceUri

userPermissions

List<String> userPermissions

vendorName

String vendorName

vendorOAuthClientIds

List<String> vendorOAuthClientIds

vendorWebsiteUri

String vendorWebsiteUri

Class com.mypurecloud.sdk.v2.model.IntegrationTypeEntityListing

class IntegrationTypeEntityListing extends Object implements Serializable

Serialized Fields

entities

List<IntegrationType> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.Intent

class Intent extends Object implements Serializable

Serialized Fields

name

String name

Class com.mypurecloud.sdk.v2.model.IntentDefinition

class IntentDefinition extends Object implements Serializable

Serialized Fields

additionalLanguages

Map<String,AdditionalLanguagesIntent> additionalLanguages

entityNameReferences

List<String> entityNameReferences

entityTypeBindings

List<NamedEntityTypeBinding> entityTypeBindings

id

String id

name

String name

utterances

List<NluUtterance> utterances

Class com.mypurecloud.sdk.v2.model.IntentFeedback

class IntentFeedback extends Object implements Serializable

Serialized Fields

assessment

IntentFeedback.AssessmentEnum assessment

entities

List<DetectedNamedEntity> entities

name

String name

probability

Double probability

Class com.mypurecloud.sdk.v2.model.InteractionStatsAlert

class InteractionStatsAlert extends Object implements Serializable

Serialized Fields

alertTypes

List<InteractionStatsAlert.AlertTypesEnum> alertTypes

dimension

InteractionStatsAlert.DimensionEnum dimension

dimensionValue

String dimensionValue

endDate

Date endDate

id

String id

mediaType

InteractionStatsAlert.MediaTypeEnum mediaType

metric

InteractionStatsAlert.MetricEnum metric

name

String name

notificationUsers

List<User> notificationUsers

numericRange

InteractionStatsAlert.NumericRangeEnum numericRange

ruleId

String ruleId

ruleUri

String ruleUri

selfUri

String selfUri

startDate

Date startDate

statistic

InteractionStatsAlert.StatisticEnum statistic

unread

Boolean unread

value

Double value

Class com.mypurecloud.sdk.v2.model.InteractionStatsAlertContainer

class InteractionStatsAlertContainer extends Object implements Serializable

Serialized Fields

entities

List<InteractionStatsAlert> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.InteractionStatsRule

class InteractionStatsRule extends Object implements Serializable

Serialized Fields

alertTypes

List<InteractionStatsRule.AlertTypesEnum> alertTypes

dimension

InteractionStatsRule.DimensionEnum dimension

dimensionValue

String dimensionValue

enabled

Boolean enabled

id

String id

inAlarm

Boolean inAlarm

mediaType

InteractionStatsRule.MediaTypeEnum mediaType

metric

InteractionStatsRule.MetricEnum metric

name

String name

notificationUsers

List<User> notificationUsers

numericRange

InteractionStatsRule.NumericRangeEnum numericRange

selfUri

String selfUri

statistic

InteractionStatsRule.StatisticEnum statistic

value

Double value

Class com.mypurecloud.sdk.v2.model.InteractionStatsRuleContainer

class InteractionStatsRuleContainer extends Object implements Serializable

Serialized Fields

entities

List<InteractionStatsRule> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.IntradayPerformancePredictionData

class IntradayPerformancePredictionData extends Object implements Serializable

Serialized Fields

averageSpeedOfAnswerSeconds

Double averageSpeedOfAnswerSeconds

occupancyPercent

Double occupancyPercent

serviceLevelPercent

Double serviceLevelPercent

Class com.mypurecloud.sdk.v2.model.IntradayPlanningGroupRequest

class IntradayPlanningGroupRequest extends Object implements Serializable

Serialized Fields

businessUnitDate

LocalDate businessUnitDate

categories

List<IntradayPlanningGroupRequest.CategoriesEnum> categories

intervalLengthMinutes

Integer intervalLengthMinutes

planningGroupIds

List<String> planningGroupIds

Class com.mypurecloud.sdk.v2.model.InvalidAssignment

class InvalidAssignment extends Object implements Serializable

Serialized Fields

message

String message

user

UserReference user

Class com.mypurecloud.sdk.v2.model.IpAddressAuthentication

class IpAddressAuthentication extends Object implements Serializable

Serialized Fields

networkWhitelist

List<String> networkWhitelist

Class com.mypurecloud.sdk.v2.model.IpAddressRange

class IpAddressRange extends Object implements Serializable

Serialized Fields

cidr

String cidr

region

String region

service

IpAddressRange.ServiceEnum service

Class com.mypurecloud.sdk.v2.model.IpAddressRangeListing

class IpAddressRangeListing extends Object implements Serializable

Serialized Fields

entities

List<IpAddressRange> entities

Class com.mypurecloud.sdk.v2.model.Items

class Items extends Object implements Serializable

Serialized Fields

pattern

String pattern

type

String type

Class com.mypurecloud.sdk.v2.model.ItemValidationLimits

class ItemValidationLimits extends Object implements Serializable

Serialized Fields

maxLength

MaxLength maxLength

minLength

MinLength minLength

Class com.mypurecloud.sdk.v2.model.IVR

class IVR extends Object implements Serializable

Serialized Fields

closedHoursFlow

DomainEntityRef closedHoursFlow

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

WritableDivision division

dnis

List<String> dnis

holidayHoursFlow

DomainEntityRef holidayHoursFlow

id

String id

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

openHoursFlow

DomainEntityRef openHoursFlow

scheduleGroup

DomainEntityRef scheduleGroup

selfUri

String selfUri

state

IVR.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.IVREntityListing

class IVREntityListing extends Object implements Serializable

Serialized Fields

entities

List<IVR> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.IvrEstablishedEvent

class IvrEstablishedEvent extends Object implements Serializable

Serialized Fields

ani

String ani

communicationId

String communicationId

conversationId

String conversationId

dnis

String dnis

eventDateTime

Date eventDateTime

eventId

String eventId

initialConfiguration

InitialConfiguration initialConfiguration

ivrName

String ivrName

ivrPhoneNumber

String ivrPhoneNumber

sourceConfiguration

SourceConfiguration sourceConfiguration

Class com.mypurecloud.sdk.v2.model.Journey

class Journey extends Object implements Serializable

Serialized Fields

patterns

List<JourneyPattern> patterns

Class com.mypurecloud.sdk.v2.model.JourneyAction

class JourneyAction extends Object implements Serializable

Serialized Fields

actionMap

JourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.JourneyActionMap

class JourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.JourneyAggregateDataContainer

class JourneyAggregateDataContainer extends Object implements Serializable

Serialized Fields

data

List<StatisticalResponse> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.JourneyAggregateQueryClause

class JourneyAggregateQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<JourneyAggregateQueryPredicate> predicates

type

JourneyAggregateQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.JourneyAggregateQueryFilter

class JourneyAggregateQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<JourneyAggregateQueryClause> clauses

predicates

List<JourneyAggregateQueryPredicate> predicates

type

JourneyAggregateQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.JourneyAggregateQueryPredicate

class JourneyAggregateQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

JourneyAggregateQueryPredicate.DimensionEnum dimension

operator

JourneyAggregateQueryPredicate.OperatorEnum operator

range

NumericRange range

type

JourneyAggregateQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.JourneyAggregateQueryResponse

class JourneyAggregateQueryResponse extends Object implements Serializable

Serialized Fields

results

List<JourneyAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.JourneyAggregationQuery

class JourneyAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

JourneyAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

JourneyAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<JourneyAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<JourneyAggregationQuery.MetricsEnum> metrics

timeZone

String timeZone

views

List<JourneyAggregationView> views

Class com.mypurecloud.sdk.v2.model.JourneyAggregationView

class JourneyAggregationView extends Object implements Serializable

Serialized Fields

function

JourneyAggregationView.FunctionEnum function

name

String name

range

AggregationRange range

target

JourneyAggregationView.TargetEnum target

Class com.mypurecloud.sdk.v2.model.JourneyApp

class JourneyApp extends Object implements Serializable

Serialized Fields

buildNumber

String buildNumber

name

String name

namespace

String namespace

version

String version

Class com.mypurecloud.sdk.v2.model.JourneyAsyncAggregateQueryResponse

class JourneyAsyncAggregateQueryResponse extends Object implements Serializable

Serialized Fields

cursor

String cursor

results

List<JourneyAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.JourneyAsyncAggregationQuery

class JourneyAsyncAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

JourneyAsyncAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

JourneyAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<JourneyAsyncAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<JourneyAsyncAggregationQuery.MetricsEnum> metrics

pageSize

Integer pageSize

timeZone

String timeZone

views

List<JourneyAggregationView> views

Class com.mypurecloud.sdk.v2.model.JourneyCampaign

class JourneyCampaign extends Object implements Serializable

Serialized Fields

clickId

String clickId

content

String content

medium

String medium

name

String name

network

String network

source

String source

term

String term

Class com.mypurecloud.sdk.v2.model.JourneyContext

class JourneyContext extends Object implements Serializable

Serialized Fields

customer

JourneyCustomer customer

customerSession

JourneyCustomerSession customerSession

triggeringAction

JourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.JourneyCustomer

class JourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.JourneyCustomerSession

class JourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.JourneyEventsSettings

class JourneyEventsSettings extends Object implements Serializable

Serialized Fields

clickEvents

List<SelectorEventTrigger> clickEvents

enabled

Boolean enabled

excludedQueryParameters

List<String> excludedQueryParameters

formsTrackEvents

List<FormsTrackTrigger> formsTrackEvents

idleEvents

List<IdleEventTrigger> idleEvents

inViewportEvents

List<SelectorEventTrigger> inViewportEvents

pageviewConfig

JourneyEventsSettings.PageviewConfigEnum pageviewConfig

scrollDepthEvents

List<ScrollPercentageEventTrigger> scrollDepthEvents

searchQueryParameters

List<String> searchQueryParameters

shouldKeepUrlFragment

Boolean shouldKeepUrlFragment

Class com.mypurecloud.sdk.v2.model.JourneyGeolocation

class JourneyGeolocation extends Object implements Serializable

Serialized Fields

country

String country

countryName

String countryName

latitude

Double latitude

locality

String locality

longitude

Double longitude

postalCode

String postalCode

region

String region

regionName

String regionName

source

String source

timezone

String timezone

Class com.mypurecloud.sdk.v2.model.JourneyOutcomeEventsNotificationActionMap

class JourneyOutcomeEventsNotificationActionMap extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.JourneyOutcomeEventsNotificationAssociatedValue

class JourneyOutcomeEventsNotificationAssociatedValue extends Object implements Serializable

Serialized Fields

dataType

JourneyOutcomeEventsNotificationAssociatedValue.DataTypeEnum dataType

value

BigDecimal value

Class com.mypurecloud.sdk.v2.model.JourneyOutcomeEventsNotificationBrowser

class JourneyOutcomeEventsNotificationBrowser extends Object implements Serializable

Serialized Fields

family

String family

featuresFlash

Boolean featuresFlash

featuresJava

Boolean featuresJava

featuresPdf

Boolean featuresPdf

featuresWebrtc

Boolean featuresWebrtc

fingerprint

String fingerprint

lang

String lang

version

String version

viewHeight

Integer viewHeight

viewWidth

Integer viewWidth

Class com.mypurecloud.sdk.v2.model.JourneyOutcomeEventsNotificationDevice

class JourneyOutcomeEventsNotificationDevice extends Object implements Serializable

Serialized Fields

category

JourneyOutcomeEventsNotificationDevice.CategoryEnum category

fingerprint

String fingerprint

isMobile

Boolean isMobile

osFamily

String osFamily

osVersion

String osVersion

screenHeight

Integer screenHeight

screenWidth

Integer screenWidth

type

String type

Class com.mypurecloud.sdk.v2.model.JourneyOutcomeEventsNotificationExternalContact

class JourneyOutcomeEventsNotificationExternalContact extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.JourneyOutcomeEventsNotificationGeoLocation

class JourneyOutcomeEventsNotificationGeoLocation extends Object implements Serializable

Serialized Fields

country

String country

countryName

String countryName

latitude

BigDecimal latitude

locality

String locality

longitude

BigDecimal longitude

postalCode

String postalCode

region

String region

regionName

String regionName

source

String source

timezone

String timezone

Class com.mypurecloud.sdk.v2.model.JourneyOutcomeEventsNotificationMktCampaign

class JourneyOutcomeEventsNotificationMktCampaign extends Object implements Serializable

Serialized Fields

clickId

String clickId

content

String content

medium

String medium

name

String name

network

String network

source

String source

term

String term

Class com.mypurecloud.sdk.v2.model.JourneyOutcomeEventsNotificationOutcome

class JourneyOutcomeEventsNotificationOutcome extends Object implements Serializable

Serialized Fields

displayName

String displayName

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.JourneyOutcomeEventsNotificationOutcomeAchievedMessage

class JourneyOutcomeEventsNotificationOutcomeAchievedMessage extends Object implements Serializable

Serialized Fields

associatedValue

JourneyOutcomeEventsNotificationAssociatedValue associatedValue

browser

JourneyOutcomeEventsNotificationBrowser browser

device

JourneyOutcomeEventsNotificationDevice device

geolocation

JourneyOutcomeEventsNotificationGeoLocation geolocation

ipAddress

String ipAddress

ipOrganization

String ipOrganization

mktCampaign

JourneyOutcomeEventsNotificationMktCampaign mktCampaign

outcome

JourneyOutcomeEventsNotificationOutcome outcome

userAgentString

String userAgentString

visitCreatedDate

Date visitCreatedDate

visitReferrer

JourneyOutcomeEventsNotificationReferrer visitReferrer

Class com.mypurecloud.sdk.v2.model.JourneyOutcomeEventsNotificationOutcomeAttributionMessage

class JourneyOutcomeEventsNotificationOutcomeAttributionMessage extends Object implements Serializable

Serialized Fields

associatedValue

JourneyOutcomeEventsNotificationAssociatedValue associatedValue

outcome

JourneyOutcomeEventsNotificationOutcome outcome

outcomeTouchpoints

List<JourneyOutcomeEventsNotificationOutcomeTouchpoint> outcomeTouchpoints

segmentAssignments

List<JourneyOutcomeEventsNotificationSegment> segmentAssignments

Class com.mypurecloud.sdk.v2.model.JourneyOutcomeEventsNotificationOutcomeEventsNotification

class JourneyOutcomeEventsNotificationOutcomeEventsNotification extends Object implements Serializable

Serialized Fields

correlationId

String correlationId

createdDate

Date createdDate

customerId

String customerId

customerIdType

String customerIdType

eventType

JourneyOutcomeEventsNotificationOutcomeEventsNotification.EventTypeEnum eventType

externalContact

JourneyOutcomeEventsNotificationExternalContact externalContact

id

String id

outcomeAchievedEvent

JourneyOutcomeEventsNotificationOutcomeAchievedMessage outcomeAchievedEvent

outcomeAttributionEventMessage

JourneyOutcomeEventsNotificationOutcomeAttributionMessage outcomeAttributionEventMessage

session

JourneyOutcomeEventsNotificationSession session

Class com.mypurecloud.sdk.v2.model.JourneyOutcomeEventsNotificationOutcomeTouchpoint

class JourneyOutcomeEventsNotificationOutcomeTouchpoint extends Object implements Serializable

Serialized Fields

actionMap

JourneyOutcomeEventsNotificationActionMap actionMap

channels

List<JourneyOutcomeEventsNotificationOutcomeTouchpointChannel> channels

createdDate

Date createdDate

id

String id

Class com.mypurecloud.sdk.v2.model.JourneyOutcomeEventsNotificationOutcomeTouchpointChannel

class JourneyOutcomeEventsNotificationOutcomeTouchpointChannel extends Object implements Serializable

Serialized Fields

type

JourneyOutcomeEventsNotificationOutcomeTouchpointChannel.TypeEnum type

Class com.mypurecloud.sdk.v2.model.JourneyOutcomeEventsNotificationReferrer

class JourneyOutcomeEventsNotificationReferrer extends Object implements Serializable

Serialized Fields

domain

String domain

fragment

String fragment

hostname

String hostname

keywords

String keywords

medium

JourneyOutcomeEventsNotificationReferrer.MediumEnum medium

name

String name

pathname

String pathname

queryString

String queryString

url

String url

Class com.mypurecloud.sdk.v2.model.JourneyOutcomeEventsNotificationSegment

class JourneyOutcomeEventsNotificationSegment extends Object implements Serializable

Serialized Fields

assignedDate

Date assignedDate

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.JourneyOutcomeEventsNotificationSession

class JourneyOutcomeEventsNotificationSession extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

type

String type

Class com.mypurecloud.sdk.v2.model.JourneyPage

class JourneyPage extends Object implements Serializable

Serialized Fields

breadcrumb

List<String> breadcrumb

domain

String domain

fragment

String fragment

hostname

String hostname

keywords

String keywords

lang

String lang

pathname

String pathname

queryString

String queryString

title

String title

url

String url

Class com.mypurecloud.sdk.v2.model.JourneyPattern

class JourneyPattern extends Object implements Serializable

Serialized Fields

count

Integer count

criteria

List<Criteria> criteria

eventName

String eventName

sessionType

String sessionType

streamType

JourneyPattern.StreamTypeEnum streamType

Class com.mypurecloud.sdk.v2.model.JourneySegment

class JourneySegment extends Object implements Serializable

Serialized Fields

assignmentExpirationDays

Integer assignmentExpirationDays

color

String color

context

Context context

createdDate

Date createdDate

description

String description

displayName

String displayName

externalSegment

ExternalSegment externalSegment

id

String id

isActive

Boolean isActive

journey

Journey journey

modifiedDate

Date modifiedDate

scope

JourneySegment.ScopeEnum scope

selfUri

String selfUri

shouldDisplayToAgent

Boolean shouldDisplayToAgent

version

Integer version

Class com.mypurecloud.sdk.v2.model.JourneySessionEventsNotificationBrowser

class JourneySessionEventsNotificationBrowser extends Object implements Serializable

Serialized Fields

family

String family

featuresFlash

Boolean featuresFlash

featuresJava

Boolean featuresJava

featuresPdf

Boolean featuresPdf

featuresWebrtc

Boolean featuresWebrtc

fingerprint

String fingerprint

lang

String lang

version

String version

viewHeight

Integer viewHeight

viewWidth

Integer viewWidth

Class com.mypurecloud.sdk.v2.model.JourneySessionEventsNotificationConnectedQueue

class JourneySessionEventsNotificationConnectedQueue extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.JourneySessionEventsNotificationConversation

class JourneySessionEventsNotificationConversation extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.JourneySessionEventsNotificationConversationChannel

class JourneySessionEventsNotificationConversationChannel extends Object implements Serializable

Serialized Fields

messageType

JourneySessionEventsNotificationConversationChannel.MessageTypeEnum messageType

platform

String platform

type

JourneySessionEventsNotificationConversationChannel.TypeEnum type

Class com.mypurecloud.sdk.v2.model.JourneySessionEventsNotificationConversationUserDisposition

class JourneySessionEventsNotificationConversationUserDisposition extends Object implements Serializable

Serialized Fields

code

String code

notes

String notes

user

JourneySessionEventsNotificationUser user

Class com.mypurecloud.sdk.v2.model.JourneySessionEventsNotificationDevice

class JourneySessionEventsNotificationDevice extends Object implements Serializable

Serialized Fields

category

JourneySessionEventsNotificationDevice.CategoryEnum category

fingerprint

String fingerprint

isMobile

Boolean isMobile

osFamily

String osFamily

osVersion

String osVersion

screenHeight

Integer screenHeight

screenWidth

Integer screenWidth

type

String type

Class com.mypurecloud.sdk.v2.model.JourneySessionEventsNotificationExternalContact

class JourneySessionEventsNotificationExternalContact extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.JourneySessionEventsNotificationGeoLocation

class JourneySessionEventsNotificationGeoLocation extends Object implements Serializable

Serialized Fields

country

String country

countryName

String countryName

latitude

BigDecimal latitude

locality

String locality

longitude

BigDecimal longitude

postalCode

String postalCode

region

String region

regionName

String regionName

source

String source

timezone

String timezone

Class com.mypurecloud.sdk.v2.model.JourneySessionEventsNotificationMktCampaign

class JourneySessionEventsNotificationMktCampaign extends Object implements Serializable

Serialized Fields

clickId

String clickId

content

String content

medium

String medium

name

String name

network

String network

source

String source

term

String term

Class com.mypurecloud.sdk.v2.model.JourneySessionEventsNotificationOutcome

class JourneySessionEventsNotificationOutcome extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.JourneySessionEventsNotificationOutcomeAchievement

class JourneySessionEventsNotificationOutcomeAchievement extends Object implements Serializable

Serialized Fields

achievedDate

Date achievedDate

outcome

JourneySessionEventsNotificationOutcome outcome

Class com.mypurecloud.sdk.v2.model.JourneySessionEventsNotificationPage

class JourneySessionEventsNotificationPage extends Object implements Serializable

Serialized Fields

breadcrumb

List<String> breadcrumb

domain

String domain

fragment

String fragment

hostname

String hostname

keywords

String keywords

lang

String lang

pathname

String pathname

queryString

String queryString

title

String title

url

String url

Class com.mypurecloud.sdk.v2.model.JourneySessionEventsNotificationReferrer

class JourneySessionEventsNotificationReferrer extends Object implements Serializable

Serialized Fields

domain

String domain

fragment

String fragment

hostname

String hostname

keywords

String keywords

medium

JourneySessionEventsNotificationReferrer.MediumEnum medium

name

String name

pathname

String pathname

queryString

String queryString

url

String url

Class com.mypurecloud.sdk.v2.model.JourneySessionEventsNotificationSegment

class JourneySessionEventsNotificationSegment extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.JourneySessionEventsNotificationSegmentAssignment

class JourneySessionEventsNotificationSegmentAssignment extends Object implements Serializable

Serialized Fields

assignedDate

Date assignedDate

segment

JourneySessionEventsNotificationSegment segment

Class com.mypurecloud.sdk.v2.model.JourneySessionEventsNotificationSessionEvent

class JourneySessionEventsNotificationSessionEvent extends Object implements Serializable

Serialized Fields

authenticated

Boolean authenticated

awayDate

Date awayDate

browser

JourneySessionEventsNotificationBrowser browser

conversation

JourneySessionEventsNotificationConversation conversation

conversationChannels

List<JourneySessionEventsNotificationConversationChannel> conversationChannels

conversationSubject

String conversationSubject

createdDate

Date createdDate

customerId

String customerId

customerIdType

String customerIdType

device

JourneySessionEventsNotificationDevice device

durationInSeconds

Integer durationInSeconds

endedDate

Date endedDate

eventCount

Integer eventCount

externalContact

JourneySessionEventsNotificationExternalContact externalContact

geolocation

JourneySessionEventsNotificationGeoLocation geolocation

id

String id

idleDate

Date idleDate

ipAddress

String ipAddress

ipOrganization

String ipOrganization

lastAcdOutcome

JourneySessionEventsNotificationSessionEvent.LastAcdOutcomeEnum lastAcdOutcome

lastConnectedQueue

JourneySessionEventsNotificationConnectedQueue lastConnectedQueue

lastConnectedUser

JourneySessionEventsNotificationUser lastConnectedUser

lastEvent

JourneySessionEventsNotificationSessionLastEvent lastEvent

lastPage

JourneySessionEventsNotificationPage lastPage

lastUserDisconnectType

JourneySessionEventsNotificationSessionEvent.LastUserDisconnectTypeEnum lastUserDisconnectType

lastUserDisposition

JourneySessionEventsNotificationConversationUserDisposition lastUserDisposition

mktCampaign

JourneySessionEventsNotificationMktCampaign mktCampaign

originatingDirection

JourneySessionEventsNotificationSessionEvent.OriginatingDirectionEnum originatingDirection

outcomeAchievements

List<JourneySessionEventsNotificationOutcomeAchievement> outcomeAchievements

pageviewCount

Integer pageviewCount

referrer

JourneySessionEventsNotificationReferrer referrer

screenviewCount

Integer screenviewCount

searchTerms

List<String> searchTerms

segmentAssignments

List<JourneySessionEventsNotificationSegmentAssignment> segmentAssignments

selfUri

String selfUri

type

String type

userAgentString

String userAgentString

Class com.mypurecloud.sdk.v2.model.JourneySessionEventsNotificationSessionLastEvent

class JourneySessionEventsNotificationSessionLastEvent extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

eventName

String eventName

id

String id

Class com.mypurecloud.sdk.v2.model.JourneySessionEventsNotificationUser

class JourneySessionEventsNotificationUser extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.JourneySurveyQuestion

class JourneySurveyQuestion extends Object implements Serializable

Serialized Fields

choices

List<String> choices

customerProperty

JourneySurveyQuestion.CustomerPropertyEnum customerProperty

isMandatory

Boolean isMandatory

label

String label

type

JourneySurveyQuestion.TypeEnum type

Class com.mypurecloud.sdk.v2.model.JourneyWebActionEventsNotificationActionMap

class JourneyWebActionEventsNotificationActionMap extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.JourneyWebActionEventsNotificationActionMapPageUrlCondition

class JourneyWebActionEventsNotificationActionMapPageUrlCondition extends Object implements Serializable

Serialized Fields

operator

JourneyWebActionEventsNotificationActionMapPageUrlCondition.OperatorEnum operator

values

List<String> values

Class com.mypurecloud.sdk.v2.model.JourneyWebActionEventsNotificationActionTarget

class JourneyWebActionEventsNotificationActionTarget extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.JourneyWebActionEventsNotificationBlockedWebActionOfferMessage

class JourneyWebActionEventsNotificationBlockedWebActionOfferMessage extends Object implements Serializable

Serialized Fields

action

JourneyWebActionEventsNotificationEventAction action

actionMap

JourneyWebActionEventsNotificationActionMap actionMap

actionTarget

JourneyWebActionEventsNotificationActionTarget actionTarget

blockingAction

JourneyWebActionEventsNotificationEventAction blockingAction

blockingActionMap

JourneyWebActionEventsNotificationActionMap blockingActionMap

blockingEmergencyScheduleGroup

JourneyWebActionEventsNotificationEmergencyGroup blockingEmergencyScheduleGroup

blockingFrequencyCapBehaviour

JourneyWebActionEventsNotificationBlockedWebActionOfferMessage.BlockingFrequencyCapBehaviourEnum blockingFrequencyCapBehaviour

blockingPageUrlConditions

List<JourneyWebActionEventsNotificationActionMapPageUrlCondition> blockingPageUrlConditions

blockingReason

JourneyWebActionEventsNotificationBlockedWebActionOfferMessage.BlockingReasonEnum blockingReason

blockingScheduleGroup

JourneyWebActionEventsNotificationScheduleGroup blockingScheduleGroup

Class com.mypurecloud.sdk.v2.model.JourneyWebActionEventsNotificationBrowser

class JourneyWebActionEventsNotificationBrowser extends Object implements Serializable

Serialized Fields

family

String family

featuresFlash

Boolean featuresFlash

featuresJava

Boolean featuresJava

featuresPdf

Boolean featuresPdf

featuresWebrtc

Boolean featuresWebrtc

fingerprint

String fingerprint

lang

String lang

version

String version

viewHeight

Integer viewHeight

viewWidth

Integer viewWidth

Class com.mypurecloud.sdk.v2.model.JourneyWebActionEventsNotificationDevice

class JourneyWebActionEventsNotificationDevice extends Object implements Serializable

Serialized Fields

category

JourneyWebActionEventsNotificationDevice.CategoryEnum category

fingerprint

String fingerprint

isMobile

Boolean isMobile

osFamily

String osFamily

osVersion

String osVersion

screenHeight

Integer screenHeight

screenWidth

Integer screenWidth

type

String type

Class com.mypurecloud.sdk.v2.model.JourneyWebActionEventsNotificationEmergencyGroup

class JourneyWebActionEventsNotificationEmergencyGroup extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.JourneyWebActionEventsNotificationEventAction

class JourneyWebActionEventsNotificationEventAction extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.JourneyWebActionEventsNotificationExternalContact

class JourneyWebActionEventsNotificationExternalContact extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.JourneyWebActionEventsNotificationGeoLocation

class JourneyWebActionEventsNotificationGeoLocation extends Object implements Serializable

Serialized Fields

country

String country

countryName

String countryName

latitude

BigDecimal latitude

locality

String locality

longitude

BigDecimal longitude

postalCode

String postalCode

region

String region

regionName

String regionName

source

String source

timezone

String timezone

Class com.mypurecloud.sdk.v2.model.JourneyWebActionEventsNotificationMktCampaign

class JourneyWebActionEventsNotificationMktCampaign extends Object implements Serializable

Serialized Fields

clickId

String clickId

content

String content

medium

String medium

name

String name

network

String network

source

String source

term

String term

Class com.mypurecloud.sdk.v2.model.JourneyWebActionEventsNotificationReferrer

class JourneyWebActionEventsNotificationReferrer extends Object implements Serializable

Serialized Fields

domain

String domain

fragment

String fragment

hostname

String hostname

keywords

String keywords

medium

JourneyWebActionEventsNotificationReferrer.MediumEnum medium

name

String name

pathname

String pathname

queryString

String queryString

url

String url

Class com.mypurecloud.sdk.v2.model.JourneyWebActionEventsNotificationScheduleGroup

class JourneyWebActionEventsNotificationScheduleGroup extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.JourneyWebActionEventsNotificationSession

class JourneyWebActionEventsNotificationSession extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

type

String type

Class com.mypurecloud.sdk.v2.model.JourneyWebActionEventsNotificationWebActionEventsNotification

class JourneyWebActionEventsNotificationWebActionEventsNotification extends Object implements Serializable

Serialized Fields

blockedWebActionOfferEvent

JourneyWebActionEventsNotificationBlockedWebActionOfferMessage blockedWebActionOfferEvent

correlationId

String correlationId

createdDate

Date createdDate

customerId

String customerId

customerIdType

String customerIdType

eventType

JourneyWebActionEventsNotificationWebActionEventsNotification.EventTypeEnum eventType

externalContact

JourneyWebActionEventsNotificationExternalContact externalContact

id

String id

session

JourneyWebActionEventsNotificationSession session

webActionEvent

JourneyWebActionEventsNotificationWebActionMessage webActionEvent

Class com.mypurecloud.sdk.v2.model.JourneyWebActionEventsNotificationWebActionMessage

class JourneyWebActionEventsNotificationWebActionMessage extends Object implements Serializable

Serialized Fields

action

JourneyWebActionEventsNotificationEventAction action

actionMap

JourneyWebActionEventsNotificationActionMap actionMap

actionTarget

JourneyWebActionEventsNotificationActionTarget actionTarget

browser

JourneyWebActionEventsNotificationBrowser browser

device

JourneyWebActionEventsNotificationDevice device

errorCode

String errorCode

errorMessage

String errorMessage

geolocation

JourneyWebActionEventsNotificationGeoLocation geolocation

ipAddress

String ipAddress

ipOrganization

String ipOrganization

mktCampaign

JourneyWebActionEventsNotificationMktCampaign mktCampaign

timeToDisposition

Integer timeToDisposition

userAgentString

String userAgentString

visitReferrer

JourneyWebActionEventsNotificationReferrer visitReferrer

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationActionMap

class JourneyWebEventsNotificationActionMap extends Object implements Serializable

Serialized Fields

displayName

String displayName

id

String id

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationActionTarget

class JourneyWebEventsNotificationActionTarget extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationAssociatedValue

class JourneyWebEventsNotificationAssociatedValue extends Object implements Serializable

Serialized Fields

dataType

JourneyWebEventsNotificationAssociatedValue.DataTypeEnum dataType

value

BigDecimal value

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationBrowser

class JourneyWebEventsNotificationBrowser extends Object implements Serializable

Serialized Fields

family

String family

featuresFlash

Boolean featuresFlash

featuresJava

Boolean featuresJava

featuresPdf

Boolean featuresPdf

featuresWebrtc

Boolean featuresWebrtc

fingerprint

String fingerprint

lang

String lang

version

String version

viewHeight

Integer viewHeight

viewWidth

Integer viewWidth

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationCustomEventAttribute

class JourneyWebEventsNotificationCustomEventAttribute extends Object implements Serializable

Serialized Fields

dataType

JourneyWebEventsNotificationCustomEventAttribute.DataTypeEnum dataType

value

String value

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationDevice

class JourneyWebEventsNotificationDevice extends Object implements Serializable

Serialized Fields

category

JourneyWebEventsNotificationDevice.CategoryEnum category

fingerprint

String fingerprint

isMobile

Boolean isMobile

osFamily

String osFamily

osVersion

String osVersion

screenHeight

Integer screenHeight

screenWidth

Integer screenWidth

type

String type

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationEventAction

class JourneyWebEventsNotificationEventAction extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

id

String id

mediaType

JourneyWebEventsNotificationEventAction.MediaTypeEnum mediaType

prompt

String prompt

state

JourneyWebEventsNotificationEventAction.StateEnum state

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationExternalContact

class JourneyWebEventsNotificationExternalContact extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationGeoLocation

class JourneyWebEventsNotificationGeoLocation extends Object implements Serializable

Serialized Fields

country

String country

countryName

String countryName

latitude

BigDecimal latitude

locality

String locality

longitude

BigDecimal longitude

postalCode

String postalCode

region

String region

regionName

String regionName

source

String source

timezone

String timezone

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationMktCampaign

class JourneyWebEventsNotificationMktCampaign extends Object implements Serializable

Serialized Fields

clickId

String clickId

content

String content

medium

String medium

name

String name

network

String network

source

String source

term

String term

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationOutcome

class JourneyWebEventsNotificationOutcome extends Object implements Serializable

Serialized Fields

displayName

String displayName

id

String id

selfUri

String selfUri

version

String version

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationOutcomeAchievedMessage

class JourneyWebEventsNotificationOutcomeAchievedMessage extends Object implements Serializable

Serialized Fields

associatedValue

JourneyWebEventsNotificationAssociatedValue associatedValue

browser

JourneyWebEventsNotificationBrowser browser

device

JourneyWebEventsNotificationDevice device

geolocation

JourneyWebEventsNotificationGeoLocation geolocation

ipAddress

String ipAddress

ipOrganization

String ipOrganization

mktCampaign

JourneyWebEventsNotificationMktCampaign mktCampaign

outcome

JourneyWebEventsNotificationOutcome outcome

userAgentString

String userAgentString

visitCreatedDate

Date visitCreatedDate

visitReferrer

JourneyWebEventsNotificationReferrer visitReferrer

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationPage

class JourneyWebEventsNotificationPage extends Object implements Serializable

Serialized Fields

breadcrumb

List<String> breadcrumb

domain

String domain

fragment

String fragment

hostname

String hostname

keywords

String keywords

lang

String lang

pathname

String pathname

queryString

String queryString

title

String title

url

String url

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationReferrer

class JourneyWebEventsNotificationReferrer extends Object implements Serializable

Serialized Fields

domain

String domain

fragment

String fragment

hostname

String hostname

keywords

String keywords

medium

JourneyWebEventsNotificationReferrer.MediumEnum medium

name

String name

pathname

String pathname

queryString

String queryString

url

String url

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationSegment

class JourneyWebEventsNotificationSegment extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationSegmentAssignmentMessage

class JourneyWebEventsNotificationSegmentAssignmentMessage extends Object implements Serializable

Serialized Fields

segment

JourneyWebEventsNotificationSegment segment

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationSession

class JourneyWebEventsNotificationSession extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

type

String type

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationWebActionMessage

class JourneyWebEventsNotificationWebActionMessage extends Object implements Serializable

Serialized Fields

action

JourneyWebEventsNotificationEventAction action

actionMap

JourneyWebEventsNotificationActionMap actionMap

actionTarget

JourneyWebEventsNotificationActionTarget actionTarget

browser

JourneyWebEventsNotificationBrowser browser

device

JourneyWebEventsNotificationDevice device

errorCode

String errorCode

errorMessage

String errorMessage

geolocation

JourneyWebEventsNotificationGeoLocation geolocation

ipAddress

String ipAddress

ipOrganization

String ipOrganization

mktCampaign

JourneyWebEventsNotificationMktCampaign mktCampaign

timeToDisposition

Integer timeToDisposition

userAgentString

String userAgentString

visitReferrer

JourneyWebEventsNotificationReferrer visitReferrer

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationWebEventsNotification

class JourneyWebEventsNotificationWebEventsNotification extends Object implements Serializable

Serialized Fields

correlationId

String correlationId

createdDate

Date createdDate

customerId

String customerId

customerIdType

String customerIdType

eventType

JourneyWebEventsNotificationWebEventsNotification.EventTypeEnum eventType

externalContact

JourneyWebEventsNotificationExternalContact externalContact

id

String id

outcomeAchievedEvent

JourneyWebEventsNotificationOutcomeAchievedMessage outcomeAchievedEvent

segmentAssignmentEvent

JourneyWebEventsNotificationSegmentAssignmentMessage segmentAssignmentEvent

session

JourneyWebEventsNotificationSession session

webActionEvent

JourneyWebEventsNotificationWebActionMessage webActionEvent

webEvent

JourneyWebEventsNotificationWebMessage webEvent

Class com.mypurecloud.sdk.v2.model.JourneyWebEventsNotificationWebMessage

class JourneyWebEventsNotificationWebMessage extends Object implements Serializable

Serialized Fields

attributes

Map<String,JourneyWebEventsNotificationCustomEventAttribute> attributes

authenticated

Boolean authenticated

browser

JourneyWebEventsNotificationBrowser browser

device

JourneyWebEventsNotificationDevice device

eventName

String eventName

geolocation

JourneyWebEventsNotificationGeoLocation geolocation

ipAddress

String ipAddress

ipOrganization

String ipOrganization

mktCampaign

JourneyWebEventsNotificationMktCampaign mktCampaign

page

JourneyWebEventsNotificationPage page

referrer

JourneyWebEventsNotificationReferrer referrer

searchQuery

String searchQuery

totalEventCount

Integer totalEventCount

totalPageviewCount

Integer totalPageviewCount

traits

Map<String,JourneyWebEventsNotificationCustomEventAttribute> traits

userAgentString

String userAgentString

Class com.mypurecloud.sdk.v2.model.JsonCursorSearchResponse

class JsonCursorSearchResponse extends Object implements Serializable

Serialized Fields

aggregations

com.fasterxml.jackson.databind.node.ArrayNode aggregations

cursor

String cursor

results

com.fasterxml.jackson.databind.node.ArrayNode results

types

List<String> types

Class com.mypurecloud.sdk.v2.model.JsonNodeSearchResponse

class JsonNodeSearchResponse extends Object implements Serializable

Serialized Fields

aggregations

com.fasterxml.jackson.databind.node.ArrayNode aggregations

currentPage

String currentPage

nextPage

String nextPage

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousPage

String previousPage

results

com.fasterxml.jackson.databind.node.ArrayNode results

total

Long total

types

List<String> types

Class com.mypurecloud.sdk.v2.model.JsonSchemaDocument

class JsonSchemaDocument extends Object implements Serializable

Serialized Fields

additionalProperties

Object additionalProperties

description

String description

id

String id

properties

Map<String,Object> properties

required

List<String> required

schema

String schema

title

String title

type

String type

Class com.mypurecloud.sdk.v2.model.JsonSearchResponse

class JsonSearchResponse extends Object implements Serializable

Serialized Fields

aggregations

com.fasterxml.jackson.databind.node.ArrayNode aggregations

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

results

com.fasterxml.jackson.databind.node.ArrayNode results

total

Long total

types

List<String> types

Class com.mypurecloud.sdk.v2.model.KeyPerformanceIndicator

class KeyPerformanceIndicator extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

id

String id

kpiGroup

KeyPerformanceIndicator.KpiGroupEnum kpiGroup

kpiType

KeyPerformanceIndicator.KpiTypeEnum kpiType

name

String name

optimizationType

KeyPerformanceIndicator.OptimizationTypeEnum optimizationType

outcomeConfig

OutcomeConfig outcomeConfig

problemType

KeyPerformanceIndicator.ProblemTypeEnum problemType

queues

List<String> queues

selfUri

String selfUri

source

KeyPerformanceIndicator.SourceEnum source

status

KeyPerformanceIndicator.StatusEnum status

wrapUpCodeConfig

WrapUpCodeConfig wrapUpCodeConfig

Class com.mypurecloud.sdk.v2.model.KeyPerformanceIndicatorAssessment

class KeyPerformanceIndicatorAssessment extends Object implements Serializable

Serialized Fields

assessmentResult

KeyPerformanceIndicatorAssessment.AssessmentResultEnum assessmentResult

checks

List<Check> checks

kpi

String kpi

Class com.mypurecloud.sdk.v2.model.KeyRotationSchedule

class KeyRotationSchedule extends Object implements Serializable

Serialized Fields

id

String id

name

String name

period

KeyRotationSchedule.PeriodEnum period

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.KeyValue

class KeyValue extends Object implements Serializable

Serialized Fields

key

String key

value

String value

Class com.mypurecloud.sdk.v2.model.KlaxonHeartBeatAlertsTopicHeartBeatAlert

class KlaxonHeartBeatAlertsTopicHeartBeatAlert extends Object implements Serializable

Serialized Fields

alertTypes

List<KlaxonHeartBeatAlertsTopicHeartBeatAlert.AlertTypesEnum> alertTypes

endDate

Date endDate

heartBeatTimeoutInMinutes

BigDecimal heartBeatTimeoutInMinutes

id

String id

name

String name

notificationUsers

List<KlaxonHeartBeatAlertsTopicNotificationUser> notificationUsers

ruleId

String ruleId

ruleType

KlaxonHeartBeatAlertsTopicHeartBeatAlert.RuleTypeEnum ruleType

senderId

String senderId

startDate

Date startDate

Class com.mypurecloud.sdk.v2.model.KlaxonHeartBeatAlertsTopicNotificationUser

class KlaxonHeartBeatAlertsTopicNotificationUser extends Object implements Serializable

Serialized Fields

displayName

String displayName

id

String id

Class com.mypurecloud.sdk.v2.model.KlaxonHeartBeatRulesTopicHeartBeatRule

class KlaxonHeartBeatRulesTopicHeartBeatRule extends Object implements Serializable

Serialized Fields

alertTypes

List<KlaxonHeartBeatRulesTopicHeartBeatRule.AlertTypesEnum> alertTypes

enabled

Boolean enabled

heartBeatTimeoutInMinutes

BigDecimal heartBeatTimeoutInMinutes

id

String id

inAlarm

Boolean inAlarm

name

String name

notificationUsers

List<KlaxonHeartBeatRulesTopicNotificationUser> notificationUsers

ruleType

KlaxonHeartBeatRulesTopicHeartBeatRule.RuleTypeEnum ruleType

senderId

String senderId

Class com.mypurecloud.sdk.v2.model.KlaxonHeartBeatRulesTopicNotificationUser

class KlaxonHeartBeatRulesTopicNotificationUser extends Object implements Serializable

Serialized Fields

displayName

String displayName

id

String id

Class com.mypurecloud.sdk.v2.model.KlaxonInteractionStatsAlertsTopicInteractionStatAlert

class KlaxonInteractionStatsAlertsTopicInteractionStatAlert extends Object implements Serializable

Serialized Fields

alertTypes

List<KlaxonInteractionStatsAlertsTopicInteractionStatAlert.AlertTypesEnum> alertTypes

dimension

KlaxonInteractionStatsAlertsTopicInteractionStatAlert.DimensionEnum dimension

dimensionValue

String dimensionValue

dimensionValueName

String dimensionValueName

endDate

Date endDate

id

String id

mediaType

KlaxonInteractionStatsAlertsTopicInteractionStatAlert.MediaTypeEnum mediaType

metric

KlaxonInteractionStatsAlertsTopicInteractionStatAlert.MetricEnum metric

name

String name

notificationUsers

List<KlaxonInteractionStatsAlertsTopicNotificationUser> notificationUsers

numericRange

KlaxonInteractionStatsAlertsTopicInteractionStatAlert.NumericRangeEnum numericRange

ruleId

String ruleId

startDate

Date startDate

statistic

KlaxonInteractionStatsAlertsTopicInteractionStatAlert.StatisticEnum statistic

unread

Boolean unread

value

BigDecimal value

Class com.mypurecloud.sdk.v2.model.KlaxonInteractionStatsAlertsTopicNotificationUser

class KlaxonInteractionStatsAlertsTopicNotificationUser extends Object implements Serializable

Serialized Fields

displayName

String displayName

id

String id

Class com.mypurecloud.sdk.v2.model.KlaxonInteractionStatsRulesTopicInteractionStatRule

class KlaxonInteractionStatsRulesTopicInteractionStatRule extends Object implements Serializable

Serialized Fields

alertTypes

List<KlaxonInteractionStatsRulesTopicInteractionStatRule.AlertTypesEnum> alertTypes

dimension

KlaxonInteractionStatsRulesTopicInteractionStatRule.DimensionEnum dimension

dimensionValue

String dimensionValue

dimensionValueName

String dimensionValueName

enabled

Boolean enabled

id

String id

inAlarm

Boolean inAlarm

mediaType

KlaxonInteractionStatsRulesTopicInteractionStatRule.MediaTypeEnum mediaType

metric

KlaxonInteractionStatsRulesTopicInteractionStatRule.MetricEnum metric

name

String name

notificationUsers

List<KlaxonInteractionStatsRulesTopicNotificationUser> notificationUsers

numericRange

KlaxonInteractionStatsRulesTopicInteractionStatRule.NumericRangeEnum numericRange

statistic

KlaxonInteractionStatsRulesTopicInteractionStatRule.StatisticEnum statistic

value

BigDecimal value

Class com.mypurecloud.sdk.v2.model.KlaxonInteractionStatsRulesTopicNotificationUser

class KlaxonInteractionStatsRulesTopicNotificationUser extends Object implements Serializable

Serialized Fields

displayName

String displayName

id

String id

Class com.mypurecloud.sdk.v2.model.Knowledge

class Knowledge extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

knowledgeBase

AddressableEntityRef knowledgeBase

Class com.mypurecloud.sdk.v2.model.KnowledgeAggregateDataContainer

class KnowledgeAggregateDataContainer extends Object implements Serializable

Serialized Fields

data

List<StatisticalResponse> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.KnowledgeAggregateQueryClause

class KnowledgeAggregateQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<KnowledgeAggregateQueryPredicate> predicates

type

KnowledgeAggregateQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.KnowledgeAggregateQueryFilter

class KnowledgeAggregateQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<KnowledgeAggregateQueryClause> clauses

predicates

List<KnowledgeAggregateQueryPredicate> predicates

type

KnowledgeAggregateQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.KnowledgeAggregateQueryPredicate

class KnowledgeAggregateQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

KnowledgeAggregateQueryPredicate.DimensionEnum dimension

operator

KnowledgeAggregateQueryPredicate.OperatorEnum operator

range

NumericRange range

type

KnowledgeAggregateQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.KnowledgeAggregateQueryResponse

class KnowledgeAggregateQueryResponse extends Object implements Serializable

Serialized Fields

results

List<KnowledgeAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.KnowledgeAggregationQuery

class KnowledgeAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

KnowledgeAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

KnowledgeAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<KnowledgeAggregationQuery.GroupByEnum> groupBy

interval

String interval

limit

Integer limit

metrics

List<KnowledgeAggregationQuery.MetricsEnum> metrics

queryType

KnowledgeAggregationQuery.QueryTypeEnum queryType

timeZone

String timeZone

views

List<KnowledgeAggregationView> views

Class com.mypurecloud.sdk.v2.model.KnowledgeAggregationView

class KnowledgeAggregationView extends Object implements Serializable

Serialized Fields

function

KnowledgeAggregationView.FunctionEnum function

name

String name

range

AggregationRange range

target

KnowledgeAggregationView.TargetEnum target

Class com.mypurecloud.sdk.v2.model.KnowledgeAsyncAggregateQueryResponse

class KnowledgeAsyncAggregateQueryResponse extends Object implements Serializable

Serialized Fields

cursor

String cursor

results

List<KnowledgeAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.KnowledgeAsyncAggregationQuery

class KnowledgeAsyncAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

KnowledgeAsyncAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

KnowledgeAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<KnowledgeAsyncAggregationQuery.GroupByEnum> groupBy

interval

String interval

limit

Integer limit

metrics

List<KnowledgeAsyncAggregationQuery.MetricsEnum> metrics

pageSize

Integer pageSize

queryType

KnowledgeAsyncAggregationQuery.QueryTypeEnum queryType

timeZone

String timeZone

views

List<KnowledgeAggregationView> views

Class com.mypurecloud.sdk.v2.model.KnowledgeBase

class KnowledgeBase extends Object implements Serializable

Serialized Fields

articleCount

Integer articleCount

coreLanguage

KnowledgeBase.CoreLanguageEnum coreLanguage

dateCreated

Date dateCreated

dateDocumentLastModified

Date dateDocumentLastModified

dateModified

Date dateModified

description

String description

faqCount

Integer faqCount

id

String id

name

String name

published

Boolean published

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.KnowledgeBaseListing

class KnowledgeBaseListing extends Object implements Serializable

Serialized Fields

entities

List<KnowledgeBase> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.KnowledgeBaseReference

class KnowledgeBaseReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.KnowledgeCategory

class KnowledgeCategory extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

id

String id

knowledgeBase

KnowledgeBase knowledgeBase

languageCode

KnowledgeCategory.LanguageCodeEnum languageCode

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.KnowledgeCategoryRequest

class KnowledgeCategoryRequest extends Object implements Serializable

Serialized Fields

description

String description

id

String id

name

String name

parent

DocumentCategoryInput parent

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.KnowledgeContextReference

class KnowledgeContextReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.KnowledgeContextValueReference

class KnowledgeContextValueReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.KnowledgeConversationContext

class KnowledgeConversationContext extends Object implements Serializable

Serialized Fields

conversationId

String conversationId

externalContactId

String externalContactId

mediaType

KnowledgeConversationContext.MediaTypeEnum mediaType

queueId

String queueId

Class com.mypurecloud.sdk.v2.model.KnowledgeConversationContextResponse

class KnowledgeConversationContextResponse extends Object implements Serializable

Serialized Fields

conversation

AddressableEntityRef conversation

externalContact

AddressableEntityRef externalContact

mediaType

KnowledgeConversationContextResponse.MediaTypeEnum mediaType

queue

AddressableEntityRef queue

Class com.mypurecloud.sdk.v2.model.KnowledgeDocument

class KnowledgeDocument extends Object implements Serializable

Serialized Fields

article

DocumentArticle article

categories

List<KnowledgeCategory> categories

dateCreated

Date dateCreated

dateModified

Date dateModified

externalUrl

String externalUrl

faq

DocumentFaq faq

id

String id

knowledgeBase

KnowledgeBase knowledgeBase

languageCode

KnowledgeDocument.LanguageCodeEnum languageCode

name

String name

selfUri

String selfUri

type

KnowledgeDocument.TypeEnum type

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentAlternative

class KnowledgeDocumentAlternative extends Object implements Serializable

Serialized Fields

autocomplete

Boolean autocomplete

phrase

String phrase

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentBulkRemoveRequest

class KnowledgeDocumentBulkRemoveRequest extends Object implements Serializable

Serialized Fields

entities

List<WritableEntity> entities

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentBulkRequest

class KnowledgeDocumentBulkRequest extends Object implements Serializable

Serialized Fields

article

DocumentArticle article

categories

List<DocumentCategoryInput> categories

externalUrl

String externalUrl

faq

DocumentFaq faq

id

String id

type

KnowledgeDocumentBulkRequest.TypeEnum type

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentBulkUpdateEntity

class KnowledgeDocumentBulkUpdateEntity extends Object implements Serializable

Serialized Fields

categoryId

String categoryId

id

String id

labelIds

List<String> labelIds

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentBulkUpdateRequest

class KnowledgeDocumentBulkUpdateRequest extends Object implements Serializable

Serialized Fields

entities

List<KnowledgeDocumentBulkUpdateEntity> entities

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentBulkVersionAddEntity

class KnowledgeDocumentBulkVersionAddEntity extends Object implements Serializable

Serialized Fields

id

String id

restoreFromVersionId

String restoreFromVersionId

restorePrevious

Boolean restorePrevious

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentBulkVersionAddRequest

class KnowledgeDocumentBulkVersionAddRequest extends Object implements Serializable

Serialized Fields

entities

List<KnowledgeDocumentBulkVersionAddEntity> entities

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentContentUpload

class KnowledgeDocumentContentUpload extends Object implements Serializable

Serialized Fields

contentType

KnowledgeDocumentContentUpload.ContentTypeEnum contentType

document

AddressableEntityRef document

errorMessage

String errorMessage

fileName

String fileName

headers

Map<String,String> headers

id

String id

selfUri

String selfUri

status

KnowledgeDocumentContentUpload.StatusEnum status

uploadKey

String uploadKey

url

String url

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentGuestSearch

class KnowledgeDocumentGuestSearch extends Object implements Serializable

Serialized Fields

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

query

String query

queryType

KnowledgeDocumentGuestSearch.QueryTypeEnum queryType

results

List<KnowledgeDocumentGuestSearchResult> results

searchId

String searchId

sessionId

String sessionId

total

Integer total

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentGuestSearchRequest

class KnowledgeDocumentGuestSearchRequest extends Object implements Serializable

Serialized Fields

includeDraftDocuments

Boolean includeDraftDocuments

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

query

String query

queryType

KnowledgeDocumentGuestSearchRequest.QueryTypeEnum queryType

searchId

String searchId

sessionId

String sessionId

total

Integer total

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentGuestSearchResult

class KnowledgeDocumentGuestSearchResult extends Object implements Serializable

Serialized Fields

confidence

Double confidence

document

KnowledgeGuestDocument document

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentReference

class KnowledgeDocumentReference extends Object implements Serializable

Serialized Fields

id

String id

knowledgeBase

KnowledgeBaseReference knowledgeBase

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentReq

class KnowledgeDocumentReq extends Object implements Serializable

Serialized Fields

alternatives

List<KnowledgeDocumentAlternative> alternatives

categoryId

String categoryId

id

String id

labelIds

List<String> labelIds

selfUri

String selfUri

title

String title

visible

Boolean visible

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentRequest

class KnowledgeDocumentRequest extends Object implements Serializable

Serialized Fields

article

DocumentArticle article

categories

List<DocumentCategoryInput> categories

externalUrl

String externalUrl

faq

DocumentFaq faq

type

KnowledgeDocumentRequest.TypeEnum type

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentResponse

class KnowledgeDocumentResponse extends Object implements Serializable

Serialized Fields

alternatives

List<KnowledgeDocumentAlternative> alternatives

category

CategoryResponse category

createdBy

UserReference createdBy

dateCreated

Date dateCreated

dateImported

Date dateImported

dateModified

Date dateModified

datePublished

Date datePublished

documentVersion

AddressableEntityRef documentVersion

id

String id

knowledgeBase

KnowledgeBaseReference knowledgeBase

labels

List<LabelResponse> labels

lastPublishedVersionNumber

Integer lastPublishedVersionNumber

modifiedBy

UserReference modifiedBy

selfUri

String selfUri

state

KnowledgeDocumentResponse.StateEnum state

title

String title

variations

List<DocumentVariation> variations

visible

Boolean visible

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentResponseListing

class KnowledgeDocumentResponseListing extends Object implements Serializable

Serialized Fields

entities

List<KnowledgeDocumentResponse> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentSearch

class KnowledgeDocumentSearch extends Object implements Serializable

Serialized Fields

application

KnowledgeSearchClientApplication application

conversationContext

KnowledgeConversationContextResponse conversationContext

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

query

String query

queryType

KnowledgeDocumentSearch.QueryTypeEnum queryType

results

List<KnowledgeDocumentSearchResult> results

searchId

String searchId

total

Integer total

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentSearchRequest

class KnowledgeDocumentSearchRequest extends Object implements Serializable

Serialized Fields

application

KnowledgeSearchClientApplication application

conversationContext

KnowledgeConversationContext conversationContext

filter

DocumentQuery filter

includeDraftDocuments

Boolean includeDraftDocuments

interval

DocumentQueryInterval interval

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

query

String query

queryType

KnowledgeDocumentSearchRequest.QueryTypeEnum queryType

searchId

String searchId

sortBy

KnowledgeDocumentSearchRequest.SortByEnum sortBy

sortOrder

KnowledgeDocumentSearchRequest.SortOrderEnum sortOrder

total

Integer total

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentSearchResult

class KnowledgeDocumentSearchResult extends Object implements Serializable

Serialized Fields

confidence

Double confidence

document

KnowledgeDocumentResponse document

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentSuggestion

class KnowledgeDocumentSuggestion extends Object implements Serializable

Serialized Fields

pageSize

Integer pageSize

query

String query

results

List<KnowledgeDocumentSuggestionResult> results

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentSuggestionRequest

class KnowledgeDocumentSuggestionRequest extends Object implements Serializable

Serialized Fields

filter

DocumentQuery filter

includeDraftDocuments

Boolean includeDraftDocuments

interval

DocumentQueryInterval interval

pageSize

Integer pageSize

query

String query

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentSuggestionResult

class KnowledgeDocumentSuggestionResult extends Object implements Serializable

Serialized Fields

document

KnowledgeDocumentSuggestionResultDocument document

matchedPhrase

String matchedPhrase

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentSuggestionResultDocument

class KnowledgeDocumentSuggestionResultDocument extends Object implements Serializable

Serialized Fields

id

String id

knowledgeBase

KnowledgeBaseReference knowledgeBase

selfUri

String selfUri

title

String title

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentVersion

class KnowledgeDocumentVersion extends Object implements Serializable

Serialized Fields

dateExpires

Date dateExpires

datePublished

Date datePublished

document

KnowledgeDocumentResponse document

id

String id

restoreFromVersionId

String restoreFromVersionId

selfUri

String selfUri

versionNumber

Integer versionNumber

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentVersionListing

class KnowledgeDocumentVersionListing extends Object implements Serializable

Serialized Fields

entities

List<KnowledgeDocumentVersion> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentVersionVariation

class KnowledgeDocumentVersionVariation extends Object implements Serializable

Serialized Fields

body

DocumentBody body

contexts

List<DocumentVariationContext> contexts

dateCreated

Date dateCreated

dateModified

Date dateModified

documentVersion

AddressableEntityRef documentVersion

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.KnowledgeDocumentVersionVariationListing

class KnowledgeDocumentVersionVariationListing extends Object implements Serializable

Serialized Fields

entities

List<KnowledgeDocumentVersionVariation> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.KnowledgeExportJobDocumentsFilter

class KnowledgeExportJobDocumentsFilter extends Object implements Serializable

Serialized Fields

entities

List<Entity> entities

interval

String interval

Class com.mypurecloud.sdk.v2.model.KnowledgeExportJobFilter

class KnowledgeExportJobFilter extends Object implements Serializable

Serialized Fields

documentsFilter

KnowledgeExportJobDocumentsFilter documentsFilter

versionFilter

KnowledgeExportJobFilter.VersionFilterEnum versionFilter

Class com.mypurecloud.sdk.v2.model.KnowledgeExportJobRequest

class KnowledgeExportJobRequest extends Object implements Serializable

Serialized Fields

exportFilter

KnowledgeExportJobFilter exportFilter

fileType

KnowledgeExportJobRequest.FileTypeEnum fileType

Class com.mypurecloud.sdk.v2.model.KnowledgeExportJobResponse

class KnowledgeExportJobResponse extends Object implements Serializable

Serialized Fields

countDocumentProcessed

Integer countDocumentProcessed

dateCreated

Date dateCreated

dateModified

Date dateModified

downloadURL

String downloadURL

errorInformation

ErrorBody errorInformation

exportFilter

KnowledgeExportJobFilter exportFilter

fileType

KnowledgeExportJobResponse.FileTypeEnum fileType

id

String id

knowledgeBase

KnowledgeBase knowledgeBase

selfUri

String selfUri

status

KnowledgeExportJobResponse.StatusEnum status

Class com.mypurecloud.sdk.v2.model.KnowledgeExtendedCategory

class KnowledgeExtendedCategory extends Object implements Serializable

Serialized Fields

children

List<KnowledgeCategory> children

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

id

String id

knowledgeBase

KnowledgeBase knowledgeBase

languageCode

KnowledgeExtendedCategory.LanguageCodeEnum languageCode

name

String name

parent

KnowledgeCategory parent

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.KnowledgeGroupStatistics

class KnowledgeGroupStatistics extends Object implements Serializable

Serialized Fields

totalPhraseHitCount

Integer totalPhraseHitCount

unlinkedPhraseCount

Integer unlinkedPhraseCount

unlinkedPhraseHitCount

Integer unlinkedPhraseHitCount

Class com.mypurecloud.sdk.v2.model.KnowledgeGuestDocument

class KnowledgeGuestDocument extends Object implements Serializable

Serialized Fields

alternatives

List<KnowledgeDocumentAlternative> alternatives

category

GuestCategoryReference category

createdBy

UserReference createdBy

dateCreated

Date dateCreated

dateImported

Date dateImported

dateModified

Date dateModified

datePublished

Date datePublished

documentVersion

AddressableEntityRef documentVersion

id

String id

lastPublishedVersionNumber

Integer lastPublishedVersionNumber

modifiedBy

UserReference modifiedBy

selfUri

String selfUri

sessionId

String sessionId

state

KnowledgeGuestDocument.StateEnum state

title

String title

variations

List<KnowledgeGuestDocumentVariation> variations

visible

Boolean visible

Class com.mypurecloud.sdk.v2.model.KnowledgeGuestDocumentResponseListing

class KnowledgeGuestDocumentResponseListing extends Object implements Serializable

Serialized Fields

entities

List<KnowledgeGuestDocument> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.KnowledgeGuestDocumentSuggestion

class KnowledgeGuestDocumentSuggestion extends Object implements Serializable

Serialized Fields

pageSize

Integer pageSize

query

String query

results

List<KnowledgeGuestDocumentSuggestionResult> results

sessionId

String sessionId

Class com.mypurecloud.sdk.v2.model.KnowledgeGuestDocumentSuggestionRequest

class KnowledgeGuestDocumentSuggestionRequest extends Object implements Serializable

Serialized Fields

includeDraftDocuments

Boolean includeDraftDocuments

pageSize

Integer pageSize

query

String query

Class com.mypurecloud.sdk.v2.model.KnowledgeGuestDocumentSuggestionResult

class KnowledgeGuestDocumentSuggestionResult extends Object implements Serializable

Serialized Fields

matchedPhrase

String matchedPhrase

Class com.mypurecloud.sdk.v2.model.KnowledgeGuestDocumentVariation

class KnowledgeGuestDocumentVariation extends Object implements Serializable

Serialized Fields

body

DocumentBody body

contexts

List<KnowledgeGuestDocumentVariationContext> contexts

dateCreated

Date dateCreated

dateModified

Date dateModified

document

AddressableEntityRef document

documentVersion

AddressableEntityRef documentVersion

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.KnowledgeGuestDocumentVariationContext

class KnowledgeGuestDocumentVariationContext extends Object implements Serializable

Serialized Fields

context

AddressableEntityRef context

values

List<AddressableEntityRef> values

Class com.mypurecloud.sdk.v2.model.KnowledgeGuestSession

class KnowledgeGuestSession extends Object implements Serializable

Serialized Fields

app

KnowledgeGuestSessionApp app

contexts

List<KnowledgeGuestSessionContext> contexts

customerId

String customerId

id

String id

pageUrl

String pageUrl

Class com.mypurecloud.sdk.v2.model.KnowledgeGuestSessionApp

class KnowledgeGuestSessionApp extends Object implements Serializable

Serialized Fields

deploymentId

String deploymentId

type

KnowledgeGuestSessionApp.TypeEnum type

Class com.mypurecloud.sdk.v2.model.KnowledgeGuestSessionContext

class KnowledgeGuestSessionContext extends Object implements Serializable

Serialized Fields

id

String id

values

List<Entity> values

Class com.mypurecloud.sdk.v2.model.KnowledgeImport

class KnowledgeImport extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

fileType

KnowledgeImport.FileTypeEnum fileType

id

String id

ignoreHeaders

Boolean ignoreHeaders

knowledgeBase

KnowledgeBase knowledgeBase

languageCode

KnowledgeImport.LanguageCodeEnum languageCode

name

String name

report

ImportReport report

selfUri

String selfUri

status

KnowledgeImport.StatusEnum status

uploadKey

String uploadKey

Class com.mypurecloud.sdk.v2.model.KnowledgeImportJobError

class KnowledgeImportJobError extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

details

List<Detail> details

documentIndex

Integer documentIndex

entityId

String entityId

entityName

String entityName

errors

List<ErrorBody> errors

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.KnowledgeImportJobReport

class KnowledgeImportJobReport extends Object implements Serializable

Serialized Fields

errors

List<KnowledgeImportJobError> errors

statistics

KnowledgeImportJobStatistics statistics

Class com.mypurecloud.sdk.v2.model.KnowledgeImportJobRequest

class KnowledgeImportJobRequest extends Object implements Serializable

Serialized Fields

fileType

KnowledgeImportJobRequest.FileTypeEnum fileType

settings

KnowledgeImportJobSettings settings

uploadKey

String uploadKey

Class com.mypurecloud.sdk.v2.model.KnowledgeImportJobResponse

class KnowledgeImportJobResponse extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

fileType

KnowledgeImportJobResponse.FileTypeEnum fileType

id

String id

knowledgeBase

KnowledgeBase knowledgeBase

report

KnowledgeImportJobReport report

selfUri

String selfUri

settings

KnowledgeImportJobSettings settings

status

KnowledgeImportJobResponse.StatusEnum status

uploadKey

String uploadKey

Class com.mypurecloud.sdk.v2.model.KnowledgeImportJobSettings

class KnowledgeImportJobSettings extends Object implements Serializable

Serialized Fields

categoryId

String categoryId

importAsNew

Boolean importAsNew

labelIds

List<String> labelIds

visible

Boolean visible

Class com.mypurecloud.sdk.v2.model.KnowledgeImportJobStatistics

class KnowledgeImportJobStatistics extends Object implements Serializable

Serialized Fields

countCategoryImportFailure

Integer countCategoryImportFailure

countCategoryImportSuccess

Integer countCategoryImportSuccess

countCategoryValidationFailure

Integer countCategoryValidationFailure

countCategoryValidationSuccess

Integer countCategoryValidationSuccess

countDocumentImportActivityCreate

Integer countDocumentImportActivityCreate

countDocumentImportActivityUpdate

Integer countDocumentImportActivityUpdate

countDocumentImportFailure

Integer countDocumentImportFailure

countDocumentImportSuccess

Integer countDocumentImportSuccess

countDocumentStateDraft

Integer countDocumentStateDraft

countDocumentStatePublished

Integer countDocumentStatePublished

countDocumentValidationFailure

Integer countDocumentValidationFailure

countDocumentValidationSuccess

Integer countDocumentValidationSuccess

countLabelImportFailure

Integer countLabelImportFailure

countLabelImportSuccess

Integer countLabelImportSuccess

countLabelValidationFailure

Integer countLabelValidationFailure

countLabelValidationSuccess

Integer countLabelValidationSuccess

migrationDetected

Boolean migrationDetected

Class com.mypurecloud.sdk.v2.model.KnowledgeSearchClientApplication

class KnowledgeSearchClientApplication extends Object implements Serializable

Serialized Fields

assistant

AddressableEntityRef assistant

botFlow

AddressableEntityRef botFlow

deployment

AddressableEntityRef deployment

type

KnowledgeSearchClientApplication.TypeEnum type

Class com.mypurecloud.sdk.v2.model.KnowledgeSearchDocument

class KnowledgeSearchDocument extends Object implements Serializable

Serialized Fields

article

DocumentArticle article

categories

List<KnowledgeCategory> categories

confidence

Double confidence

dateCreated

Date dateCreated

dateModified

Date dateModified

externalUrl

String externalUrl

faq

DocumentFaq faq

id

String id

knowledgeBase

KnowledgeBase knowledgeBase

languageCode

KnowledgeSearchDocument.LanguageCodeEnum languageCode

name

String name

selfUri

String selfUri

type

KnowledgeSearchDocument.TypeEnum type

Class com.mypurecloud.sdk.v2.model.KnowledgeSearchRequest

class KnowledgeSearchRequest extends Object implements Serializable

Serialized Fields

documentType

KnowledgeSearchRequest.DocumentTypeEnum documentType

languageCode

String languageCode

pageNumber

Integer pageNumber

pageSize

Integer pageSize

query

String query

searchOnDraftDocuments

Boolean searchOnDraftDocuments

Class com.mypurecloud.sdk.v2.model.KnowledgeSearchResponse

class KnowledgeSearchResponse extends Object implements Serializable

Serialized Fields

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

results

List<KnowledgeSearchDocument> results

searchId

String searchId

total

Integer total

Class com.mypurecloud.sdk.v2.model.KnowledgeTraining

class KnowledgeTraining extends Object implements Serializable

Serialized Fields

dateCompleted

Date dateCompleted

datePromoted

Date datePromoted

dateTriggered

Date dateTriggered

errorMessage

String errorMessage

id

String id

knowledgeBase

KnowledgeBase knowledgeBase

knowledgeDocumentsState

KnowledgeTraining.KnowledgeDocumentsStateEnum knowledgeDocumentsState

languageCode

String languageCode

selfUri

String selfUri

status

KnowledgeTraining.StatusEnum status

Class com.mypurecloud.sdk.v2.model.KpiResult

class KpiResult extends Object implements Serializable

Serialized Fields

interactionCountOff

Long interactionCountOff

interactionCountOn

Long interactionCountOn

kpiTotalOff

Long kpiTotalOff

kpiTotalOn

Long kpiTotalOn

mediaType

KpiResult.MediaTypeEnum mediaType

percentageBenefit

Double percentageBenefit

Class com.mypurecloud.sdk.v2.model.LabelCreateRequest

class LabelCreateRequest extends Object implements Serializable

Serialized Fields

color

String color

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.LabelListing

class LabelListing extends Object implements Serializable

Serialized Fields

entities

List<LabelResponse> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.LabelResponse

class LabelResponse extends Object implements Serializable

Serialized Fields

color

String color

dateCreated

Date dateCreated

dateModified

Date dateModified

documentCount

Integer documentCount

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.LabelUpdateRequest

class LabelUpdateRequest extends Object implements Serializable

Serialized Fields

color

String color

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.Language

class Language extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

id

String id

name

String name

selfUri

String selfUri

state

Language.StateEnum state

version

String version

Class com.mypurecloud.sdk.v2.model.LanguageEntityListing

class LanguageEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Language> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.LanguageOverride

class LanguageOverride extends Object implements Serializable

Serialized Fields

engine

String engine

language

String language

voice

String voice

Class com.mypurecloud.sdk.v2.model.LanguageReference

class LanguageReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.LastAttemptByColumnConditionSettings

class LastAttemptByColumnConditionSettings extends Object implements Serializable

Serialized Fields

emailColumnName

String emailColumnName

operator

LastAttemptByColumnConditionSettings.OperatorEnum operator

smsColumnName

String smsColumnName

value

String value

Class com.mypurecloud.sdk.v2.model.LastAttemptOverallConditionSettings

class LastAttemptOverallConditionSettings extends Object implements Serializable

Serialized Fields

mediaTypes

List<LastAttemptOverallConditionSettings.MediaTypesEnum> mediaTypes

operator

LastAttemptOverallConditionSettings.OperatorEnum operator

value

String value

Class com.mypurecloud.sdk.v2.model.LastResultByColumnConditionSettings

class LastResultByColumnConditionSettings extends Object implements Serializable

Serialized Fields

emailColumnName

String emailColumnName

emailWrapupCodes

List<String> emailWrapupCodes

smsColumnName

String smsColumnName

smsWrapupCodes

List<String> smsWrapupCodes

Class com.mypurecloud.sdk.v2.model.LastResultOverallConditionSettings

class LastResultOverallConditionSettings extends Object implements Serializable

Serialized Fields

emailWrapupCodes

List<String> emailWrapupCodes

smsWrapupCodes

List<String> smsWrapupCodes

Class com.mypurecloud.sdk.v2.model.LauncherButtonSettings

class LauncherButtonSettings extends Object implements Serializable

Serialized Fields

visibility

LauncherButtonSettings.VisibilityEnum visibility

Class com.mypurecloud.sdk.v2.model.Leaderboard

class Leaderboard extends Object implements Serializable

Serialized Fields

dateEndWorkday

LocalDate dateEndWorkday

dateStartWorkday

LocalDate dateStartWorkday

division

Division division

leaders

List<LeaderboardItem> leaders

metric

AddressableEntityRef metric

performanceProfile

AddressableEntityRef performanceProfile

userRank

LeaderboardItem userRank

Class com.mypurecloud.sdk.v2.model.LeaderboardItem

class LeaderboardItem extends Object implements Serializable

Serialized Fields

points

Long points

rank

Integer rank

user

UserReference user

Class com.mypurecloud.sdk.v2.model.LearningAssessment

class LearningAssessment extends Object implements Serializable

Serialized Fields

answers

AssessmentScoringSet answers

assessmentFormId

String assessmentFormId

assessmentId

String assessmentId

contextId

String contextId

dateCreated

Date dateCreated

dateModified

Date dateModified

dateSubmitted

Date dateSubmitted

status

LearningAssessment.StatusEnum status

Class com.mypurecloud.sdk.v2.model.LearningAssessmentScoringRequest

class LearningAssessmentScoringRequest extends Object implements Serializable

Serialized Fields

answers

AssessmentScoringSet answers

assessmentForm

AssessmentForm assessmentForm

Class com.mypurecloud.sdk.v2.model.LearningAssignment

class LearningAssignment extends Object implements Serializable

Serialized Fields

assessment

LearningAssessment assessment

assessmentForm

AssessmentForm assessmentForm

createdBy

UserReference createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

dateRecommendedForCompletion

Date dateRecommendedForCompletion

id

String id

isLatest

Boolean isLatest

isManual

Boolean isManual

isOverdue

Boolean isOverdue

isPassed

Boolean isPassed

isRule

Boolean isRule

modifiedBy

UserReference modifiedBy

module

LearningModule module

percentageScore

Float percentageScore

selfUri

String selfUri

state

LearningAssignment.StateEnum state

user

UserReference user

version

Integer version

Class com.mypurecloud.sdk.v2.model.LearningAssignmentAggregateParam

class LearningAssignmentAggregateParam extends Object implements Serializable

Serialized Fields

filter

LearningAssignmentAggregateQueryRequestFilter filter

groupBy

List<LearningAssignmentAggregateParam.GroupByEnum> groupBy

interval

String interval

metrics

List<LearningAssignmentAggregateParam.MetricsEnum> metrics

Class com.mypurecloud.sdk.v2.model.LearningAssignmentAggregateQueryRequestClause

class LearningAssignmentAggregateQueryRequestClause extends Object implements Serializable

Serialized Fields

predicates

List<LearningAssignmentAggregateQueryRequestPredicate> predicates

type

LearningAssignmentAggregateQueryRequestClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.LearningAssignmentAggregateQueryRequestFilter

class LearningAssignmentAggregateQueryRequestFilter extends Object implements Serializable

Serialized Fields

clauses

List<LearningAssignmentAggregateQueryRequestClause> clauses

type

LearningAssignmentAggregateQueryRequestFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.LearningAssignmentAggregateQueryRequestPredicate

class LearningAssignmentAggregateQueryRequestPredicate extends Object implements Serializable

Serialized Fields

dimension

LearningAssignmentAggregateQueryRequestPredicate.DimensionEnum dimension

value

String value

Class com.mypurecloud.sdk.v2.model.LearningAssignmentAggregateQueryResponseData

class LearningAssignmentAggregateQueryResponseData extends Object implements Serializable

Serialized Fields

interval

String interval

metrics

List<LearningAssignmentAggregateQueryResponseMetric> metrics

Class com.mypurecloud.sdk.v2.model.LearningAssignmentAggregateQueryResponseGroupedData

class LearningAssignmentAggregateQueryResponseGroupedData extends Object implements Serializable

Serialized Fields

data

List<LearningAssignmentAggregateQueryResponseData> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.LearningAssignmentAggregateQueryResponseMetric

class LearningAssignmentAggregateQueryResponseMetric extends Object implements Serializable

Serialized Fields

metric

LearningAssignmentAggregateQueryResponseMetric.MetricEnum metric

stats

LearningAssignmentAggregateQueryResponseStats stats

Class com.mypurecloud.sdk.v2.model.LearningAssignmentAggregateQueryResponseStats

class LearningAssignmentAggregateQueryResponseStats extends Object implements Serializable

Serialized Fields

count

Integer count

max

BigDecimal max

min

BigDecimal min

sum

BigDecimal sum

Class com.mypurecloud.sdk.v2.model.LearningAssignmentAggregateResponse

class LearningAssignmentAggregateResponse extends Object implements Serializable

Serialized Fields

results

List<LearningAssignmentAggregateQueryResponseGroupedData> results

Class com.mypurecloud.sdk.v2.model.LearningAssignmentBulkAddResponse

class LearningAssignmentBulkAddResponse extends Object implements Serializable

Serialized Fields

disallowedEntities

List<DisallowedEntityLearningAssignmentItem> disallowedEntities

entities

List<LearningAssignment> entities

Class com.mypurecloud.sdk.v2.model.LearningAssignmentBulkRemoveResponse

class LearningAssignmentBulkRemoveResponse extends Object implements Serializable

Serialized Fields

disallowedEntities

List<DisallowedEntityLearningAssignmentReference> disallowedEntities

entities

List<LearningAssignmentEntity> entities

Class com.mypurecloud.sdk.v2.model.LearningAssignmentCreate

class LearningAssignmentCreate extends Object implements Serializable

Serialized Fields

moduleId

String moduleId

recommendedCompletionDate

Date recommendedCompletionDate

userId

String userId

Class com.mypurecloud.sdk.v2.model.LearningAssignmentEntity

class LearningAssignmentEntity extends Object implements Serializable

Serialized Fields

assignmentId

String assignmentId

Class com.mypurecloud.sdk.v2.model.LearningAssignmentItem

class LearningAssignmentItem extends Object implements Serializable

Serialized Fields

moduleId

String moduleId

userId

String userId

Class com.mypurecloud.sdk.v2.model.LearningAssignmentReassign

class LearningAssignmentReassign extends Object implements Serializable

Serialized Fields

lengthInMinutes

Integer lengthInMinutes

recommendedCompletionDate

Date recommendedCompletionDate

Class com.mypurecloud.sdk.v2.model.LearningAssignmentReference

class LearningAssignmentReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.LearningAssignmentReschedule

class LearningAssignmentReschedule extends Object implements Serializable

Serialized Fields

dateRecommendedForCompletion

Date dateRecommendedForCompletion

lengthInMinutes

Integer lengthInMinutes

Class com.mypurecloud.sdk.v2.model.LearningAssignmentRuleRunTopicLearningAssignmentRuleRunNotification

class LearningAssignmentRuleRunTopicLearningAssignmentRuleRunNotification extends Object implements Serializable

Serialized Fields

entities

List<LearningAssignmentRuleRunTopicLearningAssignmentsCreated> entities

total

Integer total

Class com.mypurecloud.sdk.v2.model.LearningAssignmentRuleRunTopicLearningAssignmentsCreated

class LearningAssignmentRuleRunTopicLearningAssignmentsCreated extends Object implements Serializable

Serialized Fields

module

LearningAssignmentRuleRunTopicLearningModuleReference module

Class com.mypurecloud.sdk.v2.model.LearningAssignmentRuleRunTopicLearningModuleReference

class LearningAssignmentRuleRunTopicLearningModuleReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.LearningAssignmentsDomainEntity

class LearningAssignmentsDomainEntity extends Object implements Serializable

Serialized Fields

entities

List<LearningAssignment> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.LearningAssignmentTopicLearningAssignmentNotification

class LearningAssignmentTopicLearningAssignmentNotification extends Object implements Serializable

Serialized Fields

createdBy

LearningAssignmentTopicUserReference createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

dateRecommendedForCompletion

Date dateRecommendedForCompletion

id

String id

isOverdue

Boolean isOverdue

lengthInMinutes

Integer lengthInMinutes

modifiedBy

LearningAssignmentTopicUserReference modifiedBy

module

LearningAssignmentTopicLearningModuleReference module

state

LearningAssignmentTopicLearningAssignmentNotification.StateEnum state

user

LearningAssignmentTopicUserReference user

version

Integer version

Class com.mypurecloud.sdk.v2.model.LearningAssignmentTopicLearningModuleReference

class LearningAssignmentTopicLearningModuleReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.LearningAssignmentTopicUserReference

class LearningAssignmentTopicUserReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.LearningAssignmentUpdate

class LearningAssignmentUpdate extends Object implements Serializable

Serialized Fields

assessment

LearningAssessment assessment

state

LearningAssignmentUpdate.StateEnum state

Class com.mypurecloud.sdk.v2.model.LearningAssignmentUser

class LearningAssignmentUser extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.LearningAssignmentUserListing

class LearningAssignmentUserListing extends Object implements Serializable

Serialized Fields

entities

List<LearningAssignmentUser> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

unfilteredTotal

Integer unfilteredTotal

Class com.mypurecloud.sdk.v2.model.LearningAssignmentUserQuery

class LearningAssignmentUserQuery extends Object implements Serializable

Serialized Fields

rule

LearningModuleRule rule

searchTerm

String searchTerm

Class com.mypurecloud.sdk.v2.model.LearningCoverArtThumbnail

class LearningCoverArtThumbnail extends Object implements Serializable

Serialized Fields

resolution

String resolution

url

String url

Class com.mypurecloud.sdk.v2.model.LearningCoverArtUploadUrlRequest

class LearningCoverArtUploadUrlRequest extends Object implements Serializable

Serialized Fields

contentMd5

String contentMd5

contentType

LearningCoverArtUploadUrlRequest.ContentTypeEnum contentType

fileName

String fileName

serverSideEncryption

LearningCoverArtUploadUrlRequest.ServerSideEncryptionEnum serverSideEncryption

signedUrlTimeoutSeconds

Integer signedUrlTimeoutSeconds

Class com.mypurecloud.sdk.v2.model.LearningModule

class LearningModule extends Object implements Serializable

Serialized Fields

archivalMode

LearningModule.ArchivalModeEnum archivalMode

assessmentForm

AssessmentForm assessmentForm

completionTimeInDays

Integer completionTimeInDays

coverArt

LearningModuleCoverArtResponse coverArt

createdBy

UserReference createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

externalId

String externalId

id

String id

informSteps

List<LearningModuleInformStep> informSteps

isArchived

Boolean isArchived

isPublished

Boolean isPublished

modifiedBy

UserReference modifiedBy

name

String name

reassignSummaryData

LearningModuleReassignSummary reassignSummaryData

rule

LearningModuleRule rule

selfUri

String selfUri

source

LearningModule.SourceEnum source

summaryData

LearningModuleSummary summaryData

type

LearningModule.TypeEnum type

version

Integer version

Class com.mypurecloud.sdk.v2.model.LearningModuleCoverArtRequest

class LearningModuleCoverArtRequest extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.LearningModuleCoverArtResponse

class LearningModuleCoverArtResponse extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

thumbnails

List<LearningCoverArtThumbnail> thumbnails

url

String url

Class com.mypurecloud.sdk.v2.model.LearningModuleInformStep

class LearningModuleInformStep extends Object implements Serializable

Serialized Fields

contentType

String contentType

description

String description

displayName

String displayName

name

String name

order

Integer order

sharingUri

String sharingUri

type

LearningModuleInformStep.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.LearningModuleInformStepRequest

class LearningModuleInformStepRequest extends Object implements Serializable

Serialized Fields

contentType

String contentType

description

String description

displayName

String displayName

name

String name

order

Integer order

sharingUri

String sharingUri

type

LearningModuleInformStepRequest.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.LearningModuleJobRequest

class LearningModuleJobRequest extends Object implements Serializable

Serialized Fields

action

LearningModuleJobRequest.ActionEnum action

Class com.mypurecloud.sdk.v2.model.LearningModuleJobResponse

class LearningModuleJobResponse extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

status

LearningModuleJobResponse.StatusEnum status

Class com.mypurecloud.sdk.v2.model.LearningModulePublishResponse

class LearningModulePublishResponse extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.LearningModuleReassignSummary

class LearningModuleReassignSummary extends Object implements Serializable

Serialized Fields

assignedCount

Integer assignedCount

completedCount

Integer completedCount

inProgressCount

Integer inProgressCount

notCompletedCount

Integer notCompletedCount

totalReassigned

Integer totalReassigned

Class com.mypurecloud.sdk.v2.model.LearningModuleRequest

class LearningModuleRequest extends Object implements Serializable

Serialized Fields

assessmentForm

AssessmentForm assessmentForm

completionTimeInDays

Integer completionTimeInDays

coverArt

LearningModuleCoverArtRequest coverArt

description

String description

informSteps

List<LearningModuleInformStepRequest> informSteps

name

String name

type

LearningModuleRequest.TypeEnum type

Class com.mypurecloud.sdk.v2.model.LearningModuleRule

class LearningModuleRule extends Object implements Serializable

Serialized Fields

id

String id

isActive

Boolean isActive

parts

List<LearningModuleRuleParts> parts

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.LearningModuleRuleParts

class LearningModuleRuleParts extends Object implements Serializable

Serialized Fields

operation

LearningModuleRuleParts.OperationEnum operation

order

Integer order

selector

LearningModuleRuleParts.SelectorEnum selector

value

List<String> value

Class com.mypurecloud.sdk.v2.model.LearningModulesDomainEntityListing

class LearningModulesDomainEntityListing extends Object implements Serializable

Serialized Fields

entities

List<LearningModule> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.LearningModuleSummary

class LearningModuleSummary extends Object implements Serializable

Serialized Fields

assignedCount

Integer assignedCount

completedCount

Integer completedCount

completedSum

Float completedSum

passedCount

Integer passedCount

Class com.mypurecloud.sdk.v2.model.LearningScheduleSlotsQueryRequest

class LearningScheduleSlotsQueryRequest extends Object implements Serializable

Serialized Fields

interruptibleAssignmentId

String interruptibleAssignmentId

interval

String interval

lengthInMinutes

Integer lengthInMinutes

userIds

List<String> userIds

Class com.mypurecloud.sdk.v2.model.LearningScheduleSlotsQueryResponse

class LearningScheduleSlotsQueryResponse extends Object implements Serializable

Serialized Fields

suggestedSlots

List<LearningSlot> suggestedSlots

wfmScheduleActivities

List<LearningSlotWfmScheduleActivity> wfmScheduleActivities

Class com.mypurecloud.sdk.v2.model.LearningSlot

class LearningSlot extends Object implements Serializable

Serialized Fields

dateStart

Date dateStart

differenceRating

LearningSlot.DifferenceRatingEnum differenceRating

lengthInMinutes

Integer lengthInMinutes

staffingDifference

Double staffingDifference

Class com.mypurecloud.sdk.v2.model.LearningSlotFullDayTimeOffMarker

class LearningSlotFullDayTimeOffMarker extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

businessUnitDate

LocalDate businessUnitDate

description

String description

lengthMinutes

Integer lengthMinutes

paid

Boolean paid

timeOffRequestId

String timeOffRequestId

Class com.mypurecloud.sdk.v2.model.LearningSlotScheduleActivity

class LearningSlotScheduleActivity extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

dateStart

Date dateStart

description

String description

externalActivityId

String externalActivityId

externalActivityType

LearningSlotScheduleActivity.ExternalActivityTypeEnum externalActivityType

lengthMinutes

Integer lengthMinutes

paid

Boolean paid

timeOffRequestId

String timeOffRequestId

Class com.mypurecloud.sdk.v2.model.LearningSlotWfmScheduleActivity

class LearningSlotWfmScheduleActivity extends Object implements Serializable

Serialized Fields

activities

List<LearningSlotScheduleActivity> activities

fullDayTimeOffMarkers

List<LearningSlotFullDayTimeOffMarker> fullDayTimeOffMarkers

user

UserReference user

Class com.mypurecloud.sdk.v2.model.LexBot

class LexBot extends Object implements Serializable

Serialized Fields

description

String description

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.LexBotAlias

class LexBotAlias extends Object implements Serializable

Serialized Fields

bot

LexBot bot

botVersion

String botVersion

failureReason

String failureReason

id

String id

intents

List<LexIntent> intents

language

LexBotAlias.LanguageEnum language

name

String name

selfUri

String selfUri

status

LexBotAlias.StatusEnum status

Class com.mypurecloud.sdk.v2.model.LexBotAliasEntityListing

class LexBotAliasEntityListing extends Object implements Serializable

Serialized Fields

entities

List<LexBotAlias> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.LexBotEntityListing

class LexBotEntityListing extends Object implements Serializable

Serialized Fields

entities

List<LexBot> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.LexIntent

class LexIntent extends Object implements Serializable

Serialized Fields

description

String description

name

String name

slots

Map<String,LexSlot> slots

version

String version

Class com.mypurecloud.sdk.v2.model.LexSlot

class LexSlot extends Object implements Serializable

Serialized Fields

description

String description

name

String name

priority

Integer priority

type

String type

Class com.mypurecloud.sdk.v2.model.Library

class Library extends Object implements Serializable

Serialized Fields

createdBy

User createdBy

dateCreated

Date dateCreated

id

String id

name

String name

responseType

Library.ResponseTypeEnum responseType

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.LibraryEntityListing

class LibraryEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Library> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.LicenseAssignmentRequest

class LicenseAssignmentRequest extends Object implements Serializable

Serialized Fields

licenseId

String licenseId

userIdsAdd

List<String> userIdsAdd

userIdsRemove

List<String> userIdsRemove

Class com.mypurecloud.sdk.v2.model.LicenseBatchAssignmentRequest

class LicenseBatchAssignmentRequest extends Object implements Serializable

Serialized Fields

assignments

List<LicenseAssignmentRequest> assignments

Class com.mypurecloud.sdk.v2.model.LicenseDefinition

class LicenseDefinition extends Object implements Serializable

Serialized Fields

comprises

List<LicenseDefinition> comprises

description

String description

id

String id

permissions

Permissions permissions

prerequisites

List<AddressableLicenseDefinition> prerequisites

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.LicenseOrgToggle

class LicenseOrgToggle extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

featureName

String featureName

Class com.mypurecloud.sdk.v2.model.LicenseUpdateStatus

class LicenseUpdateStatus extends Object implements Serializable

Serialized Fields

licenseId

String licenseId

result

String result

userId

String userId

Class com.mypurecloud.sdk.v2.model.LicenseUser

class LicenseUser extends Object implements Serializable

Serialized Fields

id

String id

licenses

List<LicenseDefinition> licenses

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.Limit

class Limit extends Object implements Serializable

Serialized Fields

key

String key

value

Double value

Class com.mypurecloud.sdk.v2.model.LimitChangeRequestDetails

class LimitChangeRequestDetails extends Object implements Serializable

Serialized Fields

approvalNamespaces

List<ApprovalNamespace> approvalNamespaces

currentValue

Double currentValue

dateCompleted

Date dateCompleted

dateCreated

Date dateCreated

description

String description

id

String id

key

String key

namespace

LimitChangeRequestDetails.NamespaceEnum namespace

rejectReason

LimitChangeRequestDetails.RejectReasonEnum rejectReason

requestedValue

Double requestedValue

selfUri

String selfUri

status

LimitChangeRequestDetails.StatusEnum status

statusHistory

List<StatusChange> statusHistory

supportCaseUrl

String supportCaseUrl

Class com.mypurecloud.sdk.v2.model.LimitChangeRequestsEntityListing

class LimitChangeRequestsEntityListing extends Object implements Serializable

Serialized Fields

entities

List<LimitChangeRequestDetails> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.LimitsEntityListing

class LimitsEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Limit> entities

Class com.mypurecloud.sdk.v2.model.Line

class Line extends Object implements Serializable

Serialized Fields

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

defaultForUser

DomainEntityRef defaultForUser

description

String description

division

Division division

edgeGroup

DomainEntityRef edgeGroup

id

String id

lineBaseSettings

DomainEntityRef lineBaseSettings

loggedInUser

DomainEntityRef loggedInUser

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

primaryEdge

Edge primaryEdge

properties

Map<String,Object> properties

secondaryEdge

Edge secondaryEdge

selfUri

String selfUri

site

DomainEntityRef site

state

Line.StateEnum state

template

DomainEntityRef template

version

Integer version

Class com.mypurecloud.sdk.v2.model.LineBase

class LineBase extends Object implements Serializable

Serialized Fields

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

id

String id

lineMetaBase

DomainEntityRef lineMetaBase

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

properties

Map<String,Object> properties

selfUri

String selfUri

state

LineBase.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.LineBaseEntityListing

class LineBaseEntityListing extends Object implements Serializable

Serialized Fields

entities

List<LineBase> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.LineEntityListing

class LineEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Line> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.LineId

class LineId extends Object implements Serializable

Serialized Fields

displayName

String displayName

ids

List<LineUserId> ids

Class com.mypurecloud.sdk.v2.model.LineIntegration

class LineIntegration extends Object implements Serializable

Serialized Fields

channelId

String channelId

createdBy

DomainEntityRef createdBy

createError

ErrorBody createError

createStatus

LineIntegration.CreateStatusEnum createStatus

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

messagingSetting

MessagingSettingReference messagingSetting

modifiedBy

DomainEntityRef modifiedBy

name

String name

recipient

DomainEntityRef recipient

selfUri

String selfUri

status

String status

supportedContent

SupportedContentReference supportedContent

version

Integer version

webhookUri

String webhookUri

Class com.mypurecloud.sdk.v2.model.LineIntegrationEntityListing

class LineIntegrationEntityListing extends Object implements Serializable

Serialized Fields

entities

List<LineIntegration> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.LineIntegrationRequest

class LineIntegrationRequest extends Object implements Serializable

Serialized Fields

channelId

String channelId

channelSecret

String channelSecret

id

String id

messagingSetting

MessagingSettingRequestReference messagingSetting

name

String name

selfUri

String selfUri

serviceCode

String serviceCode

supportedContent

SupportedContentReference supportedContent

switcherSecret

String switcherSecret

Class com.mypurecloud.sdk.v2.model.LineStatus

class LineStatus extends Object implements Serializable

Serialized Fields

addressOfRecord

String addressOfRecord

contactAddresses

List<String> contactAddresses

id

String id

reachable

Boolean reachable

reachableStateTime

Date reachableStateTime

Class com.mypurecloud.sdk.v2.model.LineUserId

class LineUserId extends Object implements Serializable

Serialized Fields

userId

String userId

Class com.mypurecloud.sdk.v2.model.ListedProgram

class ListedProgram extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

description

String description

id

String id

modifiedBy

AddressableEntityRef modifiedBy

name

String name

published

Boolean published

selfUri

String selfUri

tags

List<String> tags

topicsCount

Integer topicsCount

Class com.mypurecloud.sdk.v2.model.ListedTopic

class ListedTopic extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

description

String description

dialect

String dialect

id

String id

modifiedBy

AddressableEntityRef modifiedBy

name

String name

participants

ListedTopic.ParticipantsEnum participants

phrasesCount

Integer phrasesCount

programsCount

Integer programsCount

published

Boolean published

selfUri

String selfUri

strictness

ListedTopic.StrictnessEnum strictness

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.ListItemComponent

class ListItemComponent extends Object implements Serializable

Serialized Fields

actions

ContentActions actions

description

String description

id

String id

image

String image

rmid

String rmid

title

String title

type

ListItemComponent.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ListWrapperInterval

class ListWrapperInterval extends Object implements Serializable

Serialized Fields

values

List<String> values

Class com.mypurecloud.sdk.v2.model.ListWrapperSecondaryPresence

class ListWrapperSecondaryPresence extends Object implements Serializable

Serialized Fields

values

List<SecondaryPresence> values

Class com.mypurecloud.sdk.v2.model.ListWrapperShiftStartVariance

class ListWrapperShiftStartVariance extends Object implements Serializable

Serialized Fields

values

List<ShiftStartVariance> values

Class com.mypurecloud.sdk.v2.model.ListWrapperString

class ListWrapperString extends Object implements Serializable

Serialized Fields

values

List<String> values

Class com.mypurecloud.sdk.v2.model.LocalDateRange

class LocalDateRange extends Object implements Serializable

Serialized Fields

endDate

LocalDate endDate

startDate

LocalDate startDate

Class com.mypurecloud.sdk.v2.model.LocalEncryptionConfiguration

class LocalEncryptionConfiguration extends Object implements Serializable

Serialized Fields

apiId

String apiId

apiKey

String apiKey

id

String id

name

String name

selfUri

String selfUri

url

String url

Class com.mypurecloud.sdk.v2.model.LocalEncryptionKeyRequest

class LocalEncryptionKeyRequest extends Object implements Serializable

Serialized Fields

configId

String configId

keypairId

String keypairId

publicKey

String publicKey

Class com.mypurecloud.sdk.v2.model.LocalizedLabels

class LocalizedLabels extends Object implements Serializable

Serialized Fields

key

LocalizedLabels.KeyEnum key

value

String value

Class com.mypurecloud.sdk.v2.model.LocalTime

class LocalTime extends Object implements Serializable

Serialized Fields

hour

Integer hour

minute

Integer minute

nano

Integer nano

second

Integer second

Class com.mypurecloud.sdk.v2.model.Location

class Location extends Object implements Serializable

Serialized Fields

coordinates

Map<String,Double> coordinates

floorplanId

String floorplanId

id

String id

locationDefinition

LocationDefinition locationDefinition

notes

String notes

Class com.mypurecloud.sdk.v2.model.LocationAddress

class LocationAddress extends Object implements Serializable

Serialized Fields

city

String city

country

String country

countryName

String countryName

state

String state

street1

String street1

street2

String street2

zipcode

String zipcode

Class com.mypurecloud.sdk.v2.model.LocationAddressVerificationDetails

class LocationAddressVerificationDetails extends Object implements Serializable

Serialized Fields

dateFinished

Date dateFinished

dateStarted

Date dateStarted

service

String service

status

LocationAddressVerificationDetails.StatusEnum status

Class com.mypurecloud.sdk.v2.model.LocationCreateDefinition

class LocationCreateDefinition extends Object implements Serializable

Serialized Fields

address

LocationAddress address

contactUser

String contactUser

emergencyNumber

LocationEmergencyNumber emergencyNumber

name

String name

notes

String notes

path

List<String> path

state

LocationCreateDefinition.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.LocationDefinition

class LocationDefinition extends Object implements Serializable

Serialized Fields

address

LocationAddress address

addressStored

Boolean addressStored

addressVerificationDetails

LocationAddressVerificationDetails addressVerificationDetails

addressVerified

Boolean addressVerified

contactUser

AddressableEntityRef contactUser

emergencyNumber

LocationEmergencyNumber emergencyNumber

floorplanImage

List<LocationImage> floorplanImage

id

String id

images

String images

name

String name

notes

String notes

path

List<String> path

profileImage

List<LocationImage> profileImage

selfUri

String selfUri

state

LocationDefinition.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.LocationEmergencyNumber

class LocationEmergencyNumber extends Object implements Serializable

Serialized Fields

e164

String e164

number

String number

type

LocationEmergencyNumber.TypeEnum type

Class com.mypurecloud.sdk.v2.model.LocationEntityListing

class LocationEntityListing extends Object implements Serializable

Serialized Fields

entities

List<LocationDefinition> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.LocationImage

class LocationImage extends Object implements Serializable

Serialized Fields

imageUri

String imageUri

resolution

String resolution

Class com.mypurecloud.sdk.v2.model.LocationSearchCriteria

class LocationSearchCriteria extends Object implements Serializable

Serialized Fields

dateFormat

String dateFormat

endValue

String endValue

fields

List<String> fields

group

List<LocationSearchCriteria> group

operator

LocationSearchCriteria.OperatorEnum operator

startValue

String startValue

type

LocationSearchCriteria.TypeEnum type

value

String value

values

List<String> values

Class com.mypurecloud.sdk.v2.model.LocationSearchRequest

class LocationSearchRequest extends Object implements Serializable

Serialized Fields

expand

List<String> expand

pageNumber

Integer pageNumber

pageSize

Integer pageSize

query

List<LocationSearchCriteria> query

sort

List<SearchSort> sort

sortBy

String sortBy

sortOrder

LocationSearchRequest.SortOrderEnum sortOrder

Class com.mypurecloud.sdk.v2.model.LocationsSearchResponse

class LocationsSearchResponse extends Object implements Serializable

Serialized Fields

currentPage

String currentPage

nextPage

String nextPage

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousPage

String previousPage

results

List<LocationDefinition> results

total

Long total

types

List<String> types

Class com.mypurecloud.sdk.v2.model.LocationUpdateDefinition

class LocationUpdateDefinition extends Object implements Serializable

Serialized Fields

address

LocationAddress address

contactUser

String contactUser

emergencyNumber

LocationEmergencyNumber emergencyNumber

name

String name

notes

String notes

path

List<String> path

state

LocationUpdateDefinition.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.LockInfo

class LockInfo extends Object implements Serializable

Serialized Fields

action

LockInfo.ActionEnum action

dateCreated

Date dateCreated

dateExpires

Date dateExpires

lockedBy

DomainEntityRef lockedBy

Class com.mypurecloud.sdk.v2.model.LogCaptureUserConfiguration

class LogCaptureUserConfiguration extends Object implements Serializable

Serialized Fields

dateExpired

Date dateExpired

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.LogicalInterfaceEntityListing

class LogicalInterfaceEntityListing extends Object implements Serializable

Serialized Fields

entities

List<DomainLogicalInterface> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.LongTermForecastPlanningGroupData

class LongTermForecastPlanningGroupData extends Object implements Serializable

Serialized Fields

averageHandleTimeSecondsPerDay

List<Double> averageHandleTimeSecondsPerDay

offeredPerDay

List<Double> offeredPerDay

planningGroupId

String planningGroupId

Class com.mypurecloud.sdk.v2.model.LongTermForecastResult

class LongTermForecastResult extends Object implements Serializable

Serialized Fields

planningGroups

List<LongTermForecastPlanningGroupData> planningGroups

referenceStartDate

LocalDate referenceStartDate

weekCount

Integer weekCount

Class com.mypurecloud.sdk.v2.model.LongTermForecastResultResponse

class LongTermForecastResultResponse extends Object implements Serializable

Serialized Fields

downloadUrl

String downloadUrl

result

LongTermForecastResult result

Class com.mypurecloud.sdk.v2.model.MailFromResult

class MailFromResult extends Object implements Serializable

Serialized Fields

mailFromDomain

String mailFromDomain

records

List<Record> records

status

MailFromResult.StatusEnum status

Class com.mypurecloud.sdk.v2.model.ManagementUnit

class ManagementUnit extends Object implements Serializable

Serialized Fields

businessUnit

BusinessUnitReference businessUnit

dateModified

Date dateModified

division

DivisionReference division

id

String id

metadata

WfmVersionedEntityMetadata metadata

modifiedBy

UserReference modifiedBy

name

String name

selfUri

String selfUri

settings

ManagementUnitSettingsResponse settings

startDayOfWeek

ManagementUnit.StartDayOfWeekEnum startDayOfWeek

timeZone

String timeZone

version

Integer version

Class com.mypurecloud.sdk.v2.model.ManagementUnitListing

class ManagementUnitListing extends Object implements Serializable

Serialized Fields

entities

List<ManagementUnit> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ManagementUnitReference

class ManagementUnitReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ManagementUnitSettingsRequest

class ManagementUnitSettingsRequest extends Object implements Serializable

Serialized Fields

adherence

AdherenceSettings adherence

metadata

WfmVersionedEntityMetadata metadata

scheduling

SchedulingSettingsRequest scheduling

shiftTrading

ShiftTradeSettings shiftTrading

shortTermForecasting

ShortTermForecastingSettings shortTermForecasting

timeOff

TimeOffRequestSettings timeOff

Class com.mypurecloud.sdk.v2.model.ManagementUnitSettingsResponse

class ManagementUnitSettingsResponse extends Object implements Serializable

Serialized Fields

adherence

AdherenceSettings adherence

metadata

WfmVersionedEntityMetadata metadata

scheduling

SchedulingSettingsResponse scheduling

shiftTrading

ShiftTradeSettings shiftTrading

shortTermForecasting

ShortTermForecastingSettings shortTermForecasting

timeOff

TimeOffRequestSettings timeOff

Class com.mypurecloud.sdk.v2.model.Manager

class Manager extends Object implements Serializable

Serialized Fields

ref

String ref

value

String value

Class com.mypurecloud.sdk.v2.model.MarkContactAddressUncontactableActionSettings

class MarkContactAddressUncontactableActionSettings extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.MarkContactUncontactableActionSettings

class MarkContactUncontactableActionSettings extends Object implements Serializable

Serialized Fields

mediaTypes

List<MarkContactUncontactableActionSettings.MediaTypesEnum> mediaTypes

Class com.mypurecloud.sdk.v2.model.Markdown

class Markdown extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

Class com.mypurecloud.sdk.v2.model.MatchCriteria

class MatchCriteria extends Object implements Serializable

Serialized Fields

jsonPath

String jsonPath

operator

MatchCriteria.OperatorEnum operator

value

com.fasterxml.jackson.databind.JsonNode value

values

List<com.fasterxml.jackson.databind.JsonNode> values

Class com.mypurecloud.sdk.v2.model.MatchCriteriaTestResult

class MatchCriteriaTestResult extends Object implements Serializable

Serialized Fields

generatedJsonPathCondition

String generatedJsonPathCondition

jsonPath

String jsonPath

jsonPathExtraction

List<MatchTestResult> jsonPathExtraction

match

Boolean match

operator

MatchCriteriaTestResult.OperatorEnum operator

value

com.fasterxml.jackson.databind.JsonNode value

values

List<com.fasterxml.jackson.databind.JsonNode> values

Class com.mypurecloud.sdk.v2.model.MatchShiftTradeRequest

class MatchShiftTradeRequest extends Object implements Serializable

Serialized Fields

metadata

WfmVersionedEntityMetadata metadata

receivingScheduleId

String receivingScheduleId

receivingShiftId

String receivingShiftId

Class com.mypurecloud.sdk.v2.model.MatchShiftTradeResponse

class MatchShiftTradeResponse extends Object implements Serializable

Serialized Fields

adminReviewViolations

List<ShiftTradeMatchViolation> adminReviewViolations

trade

ShiftTradeResponse trade

violations

List<ShiftTradeMatchViolation> violations

Class com.mypurecloud.sdk.v2.model.MatchTestResult

class MatchTestResult extends Object implements Serializable

Serialized Fields

path

String path

value

com.fasterxml.jackson.databind.JsonNode value

Class com.mypurecloud.sdk.v2.model.MaxLength

class MaxLength extends Object implements Serializable

Serialized Fields

max

Long max

min

Long min

Class com.mypurecloud.sdk.v2.model.MaxParticipants

class MaxParticipants extends Object implements Serializable

Serialized Fields

maxParticipants

Integer maxParticipants

Class com.mypurecloud.sdk.v2.model.MediaParticipantRequest

class MediaParticipantRequest extends Object implements Serializable

Serialized Fields

confined

Boolean confined

held

Boolean held

muted

Boolean muted

recording

Boolean recording

state

MediaParticipantRequest.StateEnum state

wrapup

WrapupInput wrapup

wrapupSkipped

Boolean wrapupSkipped

Class com.mypurecloud.sdk.v2.model.MediaPolicies

class MediaPolicies extends Object implements Serializable

Serialized Fields

callPolicy

CallMediaPolicy callPolicy

chatPolicy

ChatMediaPolicy chatPolicy

emailPolicy

EmailMediaPolicy emailPolicy

messagePolicy

MessageMediaPolicy messagePolicy

Class com.mypurecloud.sdk.v2.model.MediaRegions

class MediaRegions extends Object implements Serializable

Serialized Fields

awsCoreRegions

List<String> awsCoreRegions

awsHomeRegion

String awsHomeRegion

awsSatelliteRegions

List<String> awsSatelliteRegions

Class com.mypurecloud.sdk.v2.model.MediaResult

class MediaResult extends Object implements Serializable

Serialized Fields

mediaUri

String mediaUri

waveformData

List<Float> waveformData

Class com.mypurecloud.sdk.v2.model.MediaSettings

class MediaSettings extends Object implements Serializable

Serialized Fields

alertingTimeoutSeconds

Integer alertingTimeoutSeconds

enableAutoAnswer

Boolean enableAutoAnswer

serviceLevel

ServiceLevel serviceLevel

subTypeSettings

Map<String,BaseMediaSettings> subTypeSettings

Class com.mypurecloud.sdk.v2.model.MediaSummary

class MediaSummary extends Object implements Serializable

Serialized Fields

contactCenter

MediaSummaryDetail contactCenter

enterprise

MediaSummaryDetail enterprise

Class com.mypurecloud.sdk.v2.model.MediaSummaryDetail

class MediaSummaryDetail extends Object implements Serializable

Serialized Fields

active

Integer active

acw

Integer acw

Class com.mypurecloud.sdk.v2.model.MediaTranscription

class MediaTranscription extends Object implements Serializable

Serialized Fields

displayName

String displayName

integrationId

String integrationId

transcriptionProvider

MediaTranscription.TranscriptionProviderEnum transcriptionProvider

Class com.mypurecloud.sdk.v2.model.MediaType

class MediaType extends Object implements Serializable

Serialized Fields

type

String type

Class com.mypurecloud.sdk.v2.model.MediaTypeAccess

class MediaTypeAccess extends Object implements Serializable

Serialized Fields

inbound

List<MediaType> inbound

outbound

List<MediaType> outbound

Class com.mypurecloud.sdk.v2.model.MediaTypes

class MediaTypes extends Object implements Serializable

Serialized Fields

allow

MediaTypeAccess allow

Class com.mypurecloud.sdk.v2.model.MediaUtilization

class MediaUtilization extends Object implements Serializable

Serialized Fields

includeNonAcd

Boolean includeNonAcd

interruptableMediaTypes

List<String> interruptableMediaTypes

maximumCapacity

Integer maximumCapacity

Class com.mypurecloud.sdk.v2.model.Member

class Member extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.MemberEntity

class MemberEntity extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.MemberGroup

class MemberGroup extends Object implements Serializable

Serialized Fields

division

WritableDivision division

id

String id

memberCount

Integer memberCount

name

String name

selfUri

String selfUri

type

MemberGroup.TypeEnum type

Class com.mypurecloud.sdk.v2.model.MemberListing

class MemberListing extends Object implements Serializable

Serialized Fields

entities

List<Member> entities

Class com.mypurecloud.sdk.v2.model.MergeOperation

class MergeOperation extends Object implements Serializable

Serialized Fields

resultingContact

AddressableEntityRef resultingContact

sourceContact

AddressableEntityRef sourceContact

targetContact

AddressableEntityRef targetContact

Class com.mypurecloud.sdk.v2.model.MergeRequest

class MergeRequest extends Object implements Serializable

Serialized Fields

sourceContactId

String sourceContactId

targetContactId

String targetContactId

Class com.mypurecloud.sdk.v2.model.Message

class Message extends Object implements Serializable

Serialized Fields

afterCallWork

AfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

agentAssistantId

String agentAssistantId

authenticated

Boolean authenticated

byoSmsIntegrationId

String byoSmsIntegrationId

connectedTime

Date connectedTime

direction

Message.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectType

Message.DisconnectTypeEnum disconnectType

errorInfo

ErrorBody errorInfo

fromAddress

Address fromAddress

held

Boolean held

id

String id

initialState

Message.InitialStateEnum initialState

journeyContext

JourneyContext journeyContext

messages

List<MessageDetails> messages

peerId

String peerId

provider

String provider

recipientCountry

String recipientCountry

recipientType

String recipientType

recordingId

String recordingId

scriptId

String scriptId

segments

List<Segment> segments

startAlertingTime

Date startAlertingTime

startHoldTime

Date startHoldTime

state

Message.StateEnum state

toAddress

Address toAddress

type

Message.TypeEnum type

wrapup

Wrapup wrapup

Class com.mypurecloud.sdk.v2.model.MessageContent

class MessageContent extends Object implements Serializable

Serialized Fields

attachment

ContentAttachment attachment

buttonResponse

ContentButtonResponse buttonResponse

card

ContentCard card

carousel

ContentCarousel carousel

contentType

MessageContent.ContentTypeEnum contentType

generic

ContentGeneric generic

list

ContentList list

location

ContentLocation location

mention

MessagingRecipient mention

postback

ContentPostback postback

quickReply

ContentQuickReply quickReply

quickReplyV2

ContentQuickReplyV2 quickReplyV2

reactions

List<ContentReaction> reactions

story

ContentStory story

template

ContentNotificationTemplate template

text

ContentText text

Class com.mypurecloud.sdk.v2.model.MessageConversation

class MessageConversation extends Object implements Serializable

Serialized Fields

id

String id

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<MessageMediaParticipant> participants

recentTransfers

List<TransferResponse> recentTransfers

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.MessageConversationEntityListing

class MessageConversationEntityListing extends Object implements Serializable

Serialized Fields

entities

List<EmailConversation> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.MessageData

class MessageData extends Object implements Serializable

Serialized Fields

conversationId

String conversationId

createdBy

User createdBy

direction

MessageData.DirectionEnum direction

fromAddress

String fromAddress

id

String id

media

List<MessageMedia> media

messengerType

MessageData.MessengerTypeEnum messengerType

name

String name

normalizedMessage

ConversationNormalizedMessage normalizedMessage

normalizedReceipts

List<ConversationNormalizedMessage> normalizedReceipts

providerMessageId

String providerMessageId

selfUri

String selfUri

status

MessageData.StatusEnum status

stickers

List<MessageSticker> stickers

textBody

String textBody

timestamp

Date timestamp

toAddress

String toAddress

Class com.mypurecloud.sdk.v2.model.MessageDetails

class MessageDetails extends Object implements Serializable

Serialized Fields

errorInfo

ErrorBody errorInfo

media

List<MessageMedia> media

messageId

String messageId

messageMetadata

ConversationMessageMetadata messageMetadata

messageSegmentCount

Integer messageSegmentCount

messageStatus

MessageDetails.MessageStatusEnum messageStatus

messageTime

Date messageTime

messageURI

String messageURI

stickers

List<MessageSticker> stickers

Class com.mypurecloud.sdk.v2.model.MessageEvaluation

class MessageEvaluation extends Object implements Serializable

Serialized Fields

contactAddress

String contactAddress

contactColumn

String contactColumn

messageType

MessageEvaluation.MessageTypeEnum messageType

timestamp

Date timestamp

wrapupCodeId

String wrapupCodeId

Class com.mypurecloud.sdk.v2.model.MessageEvent

class MessageEvent extends Object implements Serializable

Serialized Fields

coBrowse

EventCoBrowse coBrowse

eventType

MessageEvent.EventTypeEnum eventType

presence

EventPresence presence

typing

EventTyping typing

Class com.mypurecloud.sdk.v2.model.MessageInfo

class MessageInfo extends Object implements Serializable

Serialized Fields

localizableMessageCode

String localizableMessageCode

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

Class com.mypurecloud.sdk.v2.model.MessageMedia

class MessageMedia extends Object implements Serializable

Serialized Fields

contentLengthBytes

Integer contentLengthBytes

id

String id

mediaType

String mediaType

name

String name

url

String url

Class com.mypurecloud.sdk.v2.model.MessageMediaAttachment

class MessageMediaAttachment extends Object implements Serializable

Serialized Fields

contentLength

Long contentLength

id

String id

mediaType

MessageMediaAttachment.MediaTypeEnum mediaType

name

String name

url

String url

Class com.mypurecloud.sdk.v2.model.MessageMediaData

class MessageMediaData extends Object implements Serializable

Serialized Fields

contentLengthBytes

Integer contentLengthBytes

id

String id

mediaType

String mediaType

name

String name

selfUri

String selfUri

status

MessageMediaData.StatusEnum status

uploadUrl

String uploadUrl

url

String url

Class com.mypurecloud.sdk.v2.model.MessageMediaParticipant

class MessageMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

authenticated

Boolean authenticated

connectedTime

Date connectedTime

conversationRoutingData

ConversationRoutingData conversationRoutingData

direction

MessageMediaParticipant.DirectionEnum direction

disconnectType

MessageMediaParticipant.DisconnectTypeEnum disconnectType

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

ErrorInfo errorInfo

externalContact

DomainEntityRef externalContact

externalOrganization

DomainEntityRef externalOrganization

flaggedReason

MessageMediaParticipant.FlaggedReasonEnum flaggedReason

fromAddress

Address fromAddress

held

Boolean held

id

String id

journeyContext

JourneyContext journeyContext

mediaRoles

List<String> mediaRoles

messages

List<MessageDetails> messages

monitoredParticipantId

String monitoredParticipantId

name

String name

peer

String peer

provider

String provider

purpose

String purpose

queue

DomainEntityRef queue

recipientCountry

String recipientCountry

recipientType

String recipientType

script

DomainEntityRef script

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

MessageMediaParticipant.StateEnum state

team

DomainEntityRef team

toAddress

Address toAddress

type

MessageMediaParticipant.TypeEnum type

user

DomainEntityRef user

wrapup

Wrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.MessageMediaPolicy

class MessageMediaPolicy extends Object implements Serializable

Serialized Fields

actions

PolicyActions actions

conditions

MessageMediaPolicyConditions conditions

Class com.mypurecloud.sdk.v2.model.MessageMediaPolicyConditions

class MessageMediaPolicyConditions extends Object implements Serializable

Serialized Fields

customerParticipation

MessageMediaPolicyConditions.CustomerParticipationEnum customerParticipation

dateRanges

List<String> dateRanges

forQueues

List<Queue> forQueues

forUsers

List<User> forUsers

languages

List<Language> languages

timeAllowed

TimeAllowed timeAllowed

wrapupCodes

List<WrapupCode> wrapupCodes

Class com.mypurecloud.sdk.v2.model.MessageSticker

class MessageSticker extends Object implements Serializable

Serialized Fields

id

String id

url

String url

Class com.mypurecloud.sdk.v2.model.MessageStickerAttachment

class MessageStickerAttachment extends Object implements Serializable

Serialized Fields

id

String id

url

String url

Class com.mypurecloud.sdk.v2.model.MessageTypingEventRequest

class MessageTypingEventRequest extends Object implements Serializable

Serialized Fields

dateSent

Date dateSent

typing

ConversationEventTyping typing

Class com.mypurecloud.sdk.v2.model.MessagingCampaign

class MessagingCampaign extends Object implements Serializable

Serialized Fields

alwaysRunning

Boolean alwaysRunning

callableTimeSet

DomainEntityRef callableTimeSet

campaignStatus

MessagingCampaign.CampaignStatusEnum campaignStatus

contactList

DomainEntityRef contactList

contactListFilters

List<DomainEntityRef> contactListFilters

contactSorts

List<ContactSort> contactSorts

dateCreated

Date dateCreated

dateModified

Date dateModified

division

DomainEntityRef division

dncLists

List<DomainEntityRef> dncLists

dynamicContactQueueingSettings

DynamicContactQueueingSettings dynamicContactQueueingSettings

emailConfig

EmailConfig emailConfig

errors

List<RestErrorDetail> errors

id

String id

messagesPerMinute

Integer messagesPerMinute

name

String name

ruleSets

List<DomainEntityRef> ruleSets

selfUri

String selfUri

smsConfig

SmsConfig smsConfig

version

Integer version

Class com.mypurecloud.sdk.v2.model.MessagingCampaignDiagnostics

class MessagingCampaignDiagnostics extends Object implements Serializable

Serialized Fields

timeZoneRescheduledContactsCount

Integer timeZoneRescheduledContactsCount

Class com.mypurecloud.sdk.v2.model.MessagingCampaignDivisionView

class MessagingCampaignDivisionView extends Object implements Serializable

Serialized Fields

division

Division division

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.MessagingCampaignDivisionViewEntityListing

class MessagingCampaignDivisionViewEntityListing extends Object implements Serializable

Serialized Fields

entities

List<MessagingCampaignDivisionView> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.MessagingCampaignEntityListing

class MessagingCampaignEntityListing extends Object implements Serializable

Serialized Fields

entities

List<MessagingCampaign> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.MessagingCampaignSchedule

class MessagingCampaignSchedule extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

intervals

List<ScheduleInterval> intervals

messagingCampaign

DomainEntityRef messagingCampaign

name

String name

selfUri

String selfUri

timeZone

String timeZone

version

Integer version

Class com.mypurecloud.sdk.v2.model.MessagingCampaignScheduleEntityListing

class MessagingCampaignScheduleEntityListing extends Object implements Serializable

Serialized Fields

entities

List<MessagingCampaignSchedule> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.MessagingIntegration

class MessagingIntegration extends Object implements Serializable

Serialized Fields

createdBy

DomainEntityRef createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

messagingSetting

MessagingSettingReference messagingSetting

messengerType

MessagingIntegration.MessengerTypeEnum messengerType

modifiedBy

DomainEntityRef modifiedBy

name

String name

recipient

DomainEntityRef recipient

selfUri

String selfUri

status

MessagingIntegration.StatusEnum status

supportedContent

SupportedContentReference supportedContent

version

Integer version

Class com.mypurecloud.sdk.v2.model.MessagingIntegrationEntityListing

class MessagingIntegrationEntityListing extends Object implements Serializable

Serialized Fields

entities

List<MessagingIntegration> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.MessagingRecipient

class MessagingRecipient extends Object implements Serializable

Serialized Fields

additionalIds

List<RecipientAdditionalIdentifier> additionalIds

email

String email

firstName

String firstName

id

String id

idType

MessagingRecipient.IdTypeEnum idType

image

String image

lastName

String lastName

nickname

String nickname

Class com.mypurecloud.sdk.v2.model.MessagingSettingReference

class MessagingSettingReference extends Object implements Serializable

Serialized Fields

content

ContentSetting content

createdBy

DomainEntityRef createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

event

EventSetting event

id

String id

name

String name

selfUri

String selfUri

updatedBy

DomainEntityRef updatedBy

version

String version

Class com.mypurecloud.sdk.v2.model.MessagingSettingRequestReference

class MessagingSettingRequestReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.MessagingSticker

class MessagingSticker extends Object implements Serializable

Serialized Fields

id

String id

messengerType

MessagingSticker.MessengerTypeEnum messengerType

name

String name

packageName

String packageName

providerPackageId

Integer providerPackageId

providerStickerId

Integer providerStickerId

providerVersion

Long providerVersion

selfUri

String selfUri

stickerType

MessagingSticker.StickerTypeEnum stickerType

uriLocation

String uriLocation

Class com.mypurecloud.sdk.v2.model.MessagingStickerEntityListing

class MessagingStickerEntityListing extends Object implements Serializable

Serialized Fields

entities

List<MessagingSticker> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.MessagingTemplate

class MessagingTemplate extends Object implements Serializable

Serialized Fields

whatsApp

WhatsAppDefinition whatsApp

Class com.mypurecloud.sdk.v2.model.MessagingTemplateRequest

class MessagingTemplateRequest extends Object implements Serializable

Serialized Fields

parameters

List<TemplateParameter> parameters

responseId

String responseId

Class com.mypurecloud.sdk.v2.model.MessengerApps

class MessengerApps extends Object implements Serializable

Serialized Fields

conversations

ConversationAppSettings conversations

knowledge

Knowledge knowledge

Class com.mypurecloud.sdk.v2.model.MessengerHomeScreen

class MessengerHomeScreen extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

logoUrl

String logoUrl

Class com.mypurecloud.sdk.v2.model.MessengerSettings

class MessengerSettings extends Object implements Serializable

Serialized Fields

apps

MessengerApps apps

enabled

Boolean enabled

fileUpload

FileUploadSettings fileUpload

homeScreen

MessengerHomeScreen homeScreen

launcherButton

LauncherButtonSettings launcherButton

styles

MessengerStyles styles

Class com.mypurecloud.sdk.v2.model.MessengerStyles

class MessengerStyles extends Object implements Serializable

Serialized Fields

primaryColor

String primaryColor

Class com.mypurecloud.sdk.v2.model.Metabase

class Metabase extends Object implements Serializable

Serialized Fields

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

id

String id

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

selfUri

String selfUri

state

Metabase.StateEnum state

type

Metabase.TypeEnum type

version

Integer version

Class com.mypurecloud.sdk.v2.model.MetaData

class MetaData extends Object implements Serializable

Serialized Fields

pairingToken

String pairingToken

pairingTrust

List<String> pairingTrust

pairingUrl

String pairingUrl

Class com.mypurecloud.sdk.v2.model.MetadataDocumentation

class MetadataDocumentation extends Object implements Serializable

Serialized Fields

description

String description

location

String location

Class com.mypurecloud.sdk.v2.model.MetadataPresentation

class MetadataPresentation extends Object implements Serializable

Serialized Fields

schema

MetadataSchema schema

title

String title

Class com.mypurecloud.sdk.v2.model.MetadataProperty

class MetadataProperty extends Object implements Serializable

Serialized Fields

_default

String _default

_enum

List<String> _enum

description

String description

help

String help

type

String type

Class com.mypurecloud.sdk.v2.model.MetadataResultEntity

class MetadataResultEntity extends Object implements Serializable

Serialized Fields

description

String description

type

String type

visibility

MetadataResultEntity.VisibilityEnum visibility

Class com.mypurecloud.sdk.v2.model.MetadataResults

class MetadataResults extends Object implements Serializable

Serialized Fields

entities

List<MetadataResultEntity> entities

Class com.mypurecloud.sdk.v2.model.MetadataSchema

class MetadataSchema extends Object implements Serializable

Serialized Fields

description

String description

properties

List<Map<String,MetadataProperty>> properties

required

List<String> required

title

String title

type

String type

Class com.mypurecloud.sdk.v2.model.MeteredAssignmentByAgent

class MeteredAssignmentByAgent extends Object implements Serializable

Serialized Fields

evaluationContextId

String evaluationContextId

evaluationForm

EvaluationForm evaluationForm

evaluators

List<User> evaluators

maxNumberEvaluations

Integer maxNumberEvaluations

timeInterval

TimeInterval timeInterval

timeZone

String timeZone

Class com.mypurecloud.sdk.v2.model.MeteredEvaluationAssignment

class MeteredEvaluationAssignment extends Object implements Serializable

Serialized Fields

assignToActiveUser

Boolean assignToActiveUser

evaluationContextId

String evaluationContextId

evaluationForm

EvaluationForm evaluationForm

evaluators

List<User> evaluators

maxNumberEvaluations

Integer maxNumberEvaluations

timeInterval

TimeInterval timeInterval

Class com.mypurecloud.sdk.v2.model.Metric

class Metric extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateUnlinked

LocalDate dateUnlinked

externalMetricDefinitionId

String externalMetricDefinitionId

id

String id

linkedMetric

AddressableEntityRef linkedMetric

metricDefinitionId

String metricDefinitionId

name

String name

objective

Objective objective

performanceProfileId

String performanceProfileId

precision

Integer precision

selfUri

String selfUri

sourcePerformanceProfile

PerformanceProfile sourcePerformanceProfile

timeDisplayUnit

Metric.TimeDisplayUnitEnum timeDisplayUnit

Class com.mypurecloud.sdk.v2.model.MetricDefinition

class MetricDefinition extends Object implements Serializable

Serialized Fields

defaultObjective

DefaultObjective defaultObjective

dividendMetrics

List<String> dividendMetrics

divisorMetrics

List<String> divisorMetrics

id

String id

lockTemplateId

String lockTemplateId

mediaTypeFilteringAllowed

Boolean mediaTypeFilteringAllowed

name

String name

queueFilteringAllowed

Boolean queueFilteringAllowed

selfUri

String selfUri

shortName

String shortName

unitType

MetricDefinition.UnitTypeEnum unitType

Class com.mypurecloud.sdk.v2.model.Metrics

class Metrics extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateUnlinked

LocalDate dateUnlinked

enabled

Boolean enabled

externalMetricDefinitionId

String externalMetricDefinitionId

id

String id

linkedMetric

AddressableEntityRef linkedMetric

maxPoints

Integer maxPoints

metricDefinitionId

String metricDefinitionId

metricDefinitionName

String metricDefinitionName

name

String name

order

Integer order

performanceProfileId

String performanceProfileId

precision

Integer precision

selfUri

String selfUri

sourcePerformanceProfile

PerformanceProfile sourcePerformanceProfile

templateName

String templateName

timeDisplayUnit

Metrics.TimeDisplayUnitEnum timeDisplayUnit

unitDefinition

String unitDefinition

unitType

Metrics.UnitTypeEnum unitType

Class com.mypurecloud.sdk.v2.model.MetricValueTrendAverage

class MetricValueTrendAverage extends Object implements Serializable

Serialized Fields

dateEndWorkday

LocalDate dateEndWorkday

dateReferenceWorkday

LocalDate dateReferenceWorkday

dateStartWorkday

LocalDate dateStartWorkday

division

Division division

metric

AddressableEntityRef metric

performanceProfile

AddressableEntityRef performanceProfile

result

WorkdayValuesMetricItem result

timezone

String timezone

user

UserReference user

Class com.mypurecloud.sdk.v2.model.MinedIntentsListing

class MinedIntentsListing extends Object implements Serializable

Serialized Fields

entities

List<MinerIntent> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.Miner

class Miner extends Object implements Serializable

Serialized Fields

conversationDataUploaded

Boolean conversationDataUploaded

conversationsDateRangeEnd

LocalDate conversationsDateRangeEnd

conversationsDateRangeStart

LocalDate conversationsDateRangeStart

conversationsFetchedCount

Integer conversationsFetchedCount

conversationsValidCount

Integer conversationsValidCount

dateCompleted

Date dateCompleted

dateCreated

Date dateCreated

dateModified

Date dateModified

dateTriggered

Date dateTriggered

errorInfo

ErrorInfo errorInfo

getminedItemCount

Integer getminedItemCount

id

String id

language

Miner.LanguageEnum language

latestDraftVersion

Draft latestDraftVersion

mediaType

Miner.MediaTypeEnum mediaType

message

String message

minerType

Miner.MinerTypeEnum minerType

name

String name

participantType

Miner.ParticipantTypeEnum participantType

queueIds

List<String> queueIds

selfUri

String selfUri

status

Miner.StatusEnum status

warningInfo

ErrorInfo warningInfo

Class com.mypurecloud.sdk.v2.model.MinerExecuteRequest

class MinerExecuteRequest extends Object implements Serializable

Serialized Fields

dateEnd

LocalDate dateEnd

dateStart

LocalDate dateStart

mediaType

MinerExecuteRequest.MediaTypeEnum mediaType

participantType

MinerExecuteRequest.ParticipantTypeEnum participantType

queueIds

List<String> queueIds

uploadKey

String uploadKey

Class com.mypurecloud.sdk.v2.model.MinerIntent

class MinerIntent extends Object implements Serializable

Serialized Fields

analyticVolumePercent

Double analyticVolumePercent

id

String id

miner

Miner miner

name

String name

selfUri

String selfUri

utterances

List<Utterance> utterances

Class com.mypurecloud.sdk.v2.model.MinerListing

class MinerListing extends Object implements Serializable

Serialized Fields

entities

List<Miner> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.MinerTopic

class MinerTopic extends Object implements Serializable

Serialized Fields

conversationCount

Integer conversationCount

conversationPercent

Float conversationPercent

id

String id

miner

Miner miner

name

String name

phraseCount

Integer phraseCount

phrases

List<TopicPhrase> phrases

selfUri

String selfUri

utteranceCount

Integer utteranceCount

Class com.mypurecloud.sdk.v2.model.MinerTopicPhrase

class MinerTopicPhrase extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

topic

MinerTopic topic

utteranceCount

Integer utteranceCount

utterances

List<Utterance> utterances

Class com.mypurecloud.sdk.v2.model.MinerTopicsListing

class MinerTopicsListing extends Object implements Serializable

Serialized Fields

entities

List<MinerTopic> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.MinLength

class MinLength extends Object implements Serializable

Serialized Fields

max

Long max

min

Long min

Class com.mypurecloud.sdk.v2.model.ModelingProcessingError

class ModelingProcessingError extends Object implements Serializable

Serialized Fields

description

String description

internalErrorCode

ModelingProcessingError.InternalErrorCodeEnum internalErrorCode

Class com.mypurecloud.sdk.v2.model.ModelingStatusResponse

class ModelingStatusResponse extends Object implements Serializable

Serialized Fields

errorDetails

List<ModelingProcessingError> errorDetails

id

String id

modelingResultUri

String modelingResultUri

status

ModelingStatusResponse.StatusEnum status

Class com.mypurecloud.sdk.v2.model.ModelVoid

class ModelVoid extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.MoveManagementUnitRequest

class MoveManagementUnitRequest extends Object implements Serializable

Serialized Fields

businessUnitId

String businessUnitId

Class com.mypurecloud.sdk.v2.model.MoveManagementUnitResponse

class MoveManagementUnitResponse extends Object implements Serializable

Serialized Fields

businessUnit

BusinessUnitReference businessUnit

status

MoveManagementUnitResponse.StatusEnum status

Class com.mypurecloud.sdk.v2.model.MuRescheduleResultWrapper

class MuRescheduleResultWrapper extends Object implements Serializable

Serialized Fields

agentSchedules

List<BuAgentScheduleRescheduleResponse> agentSchedules

Class com.mypurecloud.sdk.v2.model.NamedEntity

class NamedEntity extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.NamedEntityAnnotation

class NamedEntityAnnotation extends Object implements Serializable

Serialized Fields

name

String name

Class com.mypurecloud.sdk.v2.model.NamedEntityDefinition

class NamedEntityDefinition extends Object implements Serializable

Serialized Fields

name

String name

type

String type

Class com.mypurecloud.sdk.v2.model.NamedEntityTypeBinding

class NamedEntityTypeBinding extends Object implements Serializable

Serialized Fields

entityName

String entityName

entityType

String entityType

Class com.mypurecloud.sdk.v2.model.NamedEntityTypeDefinition

class NamedEntityTypeDefinition extends Object implements Serializable

Serialized Fields

description

String description

mechanism

NamedEntityTypeMechanism mechanism

name

String name

Class com.mypurecloud.sdk.v2.model.NamedEntityTypeItem

class NamedEntityTypeItem extends Object implements Serializable

Serialized Fields

additionalLanguages

Map<String,AdditionalLanguagesSynonyms> additionalLanguages

synonyms

List<String> synonyms

value

String value

Class com.mypurecloud.sdk.v2.model.NamedEntityTypeMechanism

class NamedEntityTypeMechanism extends Object implements Serializable

Serialized Fields

items

List<NamedEntityTypeItem> items

restricted

Boolean restricted

type

NamedEntityTypeMechanism.TypeEnum type

Class com.mypurecloud.sdk.v2.model.NetworkConnectivity

class NetworkConnectivity extends Object implements Serializable

Serialized Fields

bluetoothEnabled

Boolean bluetoothEnabled

carrier

String carrier

cellularEnabled

Boolean cellularEnabled

wifiEnabled

Boolean wifiEnabled

Class com.mypurecloud.sdk.v2.model.NluConfusionMatrixColumn

class NluConfusionMatrixColumn extends Object implements Serializable

Serialized Fields

name

String name

value

Float value

Class com.mypurecloud.sdk.v2.model.NluConfusionMatrixRow

class NluConfusionMatrixRow extends Object implements Serializable

Serialized Fields

columns

List<NluConfusionMatrixColumn> columns

name

String name

Class com.mypurecloud.sdk.v2.model.NluDetectionContext

class NluDetectionContext extends Object implements Serializable

Serialized Fields

entity

ContextEntity entity

intent

ContextIntent intent

Class com.mypurecloud.sdk.v2.model.NluDetectionInput

class NluDetectionInput extends Object implements Serializable

Serialized Fields

language

String language

text

String text

Class com.mypurecloud.sdk.v2.model.NluDetectionOutput

class NluDetectionOutput extends Object implements Serializable

Serialized Fields

dialogActs

List<DetectedDialogAct> dialogActs

intents

List<DetectedIntent> intents

Class com.mypurecloud.sdk.v2.model.NluDetectionRequest

class NluDetectionRequest extends Object implements Serializable

Serialized Fields

context

NluDetectionContext context

input

NluDetectionInput input

Class com.mypurecloud.sdk.v2.model.NluDetectionResponse

class NluDetectionResponse extends Object implements Serializable

Serialized Fields

input

NluDetectionInput input

output

NluDetectionOutput output

version

NluDomainVersion version

Class com.mypurecloud.sdk.v2.model.NluDomain

class NluDomain extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

draftVersion

NluDomainVersion draftVersion

engineVersion

String engineVersion

id

String id

language

String language

lastPublishedVersion

NluDomainVersion lastPublishedVersion

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.NluDomainListing

class NluDomainListing extends Object implements Serializable

Serialized Fields

entities

List<NluDomain> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.NluDomainVersion

class NluDomainVersion extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

datePublished

Date datePublished

dateTrained

Date dateTrained

description

String description

domain

NluDomain domain

entities

List<NamedEntityDefinition> entities

entityTypes

List<NamedEntityTypeDefinition> entityTypes

evaluationStatus

NluDomainVersion.EvaluationStatusEnum evaluationStatus

id

String id

intents

List<IntentDefinition> intents

language

String language

published

Boolean published

selfUri

String selfUri

trainingStatus

NluDomainVersion.TrainingStatusEnum trainingStatus

Class com.mypurecloud.sdk.v2.model.NluDomainVersionListing

class NluDomainVersionListing extends Object implements Serializable

Serialized Fields

entities

List<NluDomainVersion> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.NluDomainVersionQualityReport

class NluDomainVersionQualityReport extends Object implements Serializable

Serialized Fields

confusionMatrix

List<NluConfusionMatrixRow> confusionMatrix

summary

NluQualityReportSummary summary

version

NluDomainVersion version

Class com.mypurecloud.sdk.v2.model.NluDomainVersionTrainingResponse

class NluDomainVersionTrainingResponse extends Object implements Serializable

Serialized Fields

message

String message

version

NluDomainVersion version

Class com.mypurecloud.sdk.v2.model.NluFeedbackListing

class NluFeedbackListing extends Object implements Serializable

Serialized Fields

entities

List<NluFeedbackResponse> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.NluFeedbackRequest

class NluFeedbackRequest extends Object implements Serializable

Serialized Fields

intents

List<IntentFeedback> intents

language

String language

text

String text

versionId

String versionId

Class com.mypurecloud.sdk.v2.model.NluFeedbackResponse

class NluFeedbackResponse extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

id

String id

intents

List<IntentFeedback> intents

language

String language

selfUri

String selfUri

text

String text

version

NluDomainVersion version

Class com.mypurecloud.sdk.v2.model.NluInfo

class NluInfo extends Object implements Serializable

Serialized Fields

domain

AddressableEntityRef domain

engineVersion

String engineVersion

intents

List<Intent> intents

nluData

NluDomainVersion nluData

version

NluDomainVersion version

Class com.mypurecloud.sdk.v2.model.NluQualityReportSummary

class NluQualityReportSummary extends Object implements Serializable

Serialized Fields

metrics

List<NluQualityReportSummaryMetric> metrics

Class com.mypurecloud.sdk.v2.model.NluQualityReportSummaryMetric

class NluQualityReportSummaryMetric extends Object implements Serializable

Serialized Fields

name

String name

value

Float value

Class com.mypurecloud.sdk.v2.model.NluUtterance

class NluUtterance extends Object implements Serializable

Serialized Fields

id

String id

segments

List<NluUtteranceSegment> segments

Class com.mypurecloud.sdk.v2.model.NluUtteranceSegment

class NluUtteranceSegment extends Object implements Serializable

Serialized Fields

entity

NamedEntityAnnotation entity

text

String text

Class com.mypurecloud.sdk.v2.model.Note

class Note extends Object implements Serializable

Serialized Fields

createDate

Date createDate

createdBy

User createdBy

entityId

String entityId

entityType

Note.EntityTypeEnum entityType

externalDataSources

List<ExternalDataSource> externalDataSources

id

String id

modifyDate

Date modifyDate

noteText

String noteText

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.NoteListing

class NoteListing extends Object implements Serializable

Serialized Fields

entities

List<Note> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

partialResults

Boolean partialResults

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.NotificationsResponse

class NotificationsResponse extends Object implements Serializable

Serialized Fields

entities

List<WfmUserNotification> entities

Class com.mypurecloud.sdk.v2.model.NotificationTemplateBody

class NotificationTemplateBody extends Object implements Serializable

Serialized Fields

parameters

List<NotificationTemplateParameter> parameters

text

String text

Class com.mypurecloud.sdk.v2.model.NotificationTemplateFooter

class NotificationTemplateFooter extends Object implements Serializable

Serialized Fields

text

String text

Class com.mypurecloud.sdk.v2.model.NotificationTemplateHeader

class NotificationTemplateHeader extends Object implements Serializable

Serialized Fields

media

ContentAttachment media

parameters

List<NotificationTemplateParameter> parameters

text

String text

type

NotificationTemplateHeader.TypeEnum type

Class com.mypurecloud.sdk.v2.model.NotificationTemplateParameter

class NotificationTemplateParameter extends Object implements Serializable

Serialized Fields

name

String name

text

String text

Class com.mypurecloud.sdk.v2.model.NTPSettings

class NTPSettings extends Object implements Serializable

Serialized Fields

servers

List<String> servers

Class com.mypurecloud.sdk.v2.model.NuanceApplication

class NuanceApplication extends Object implements Serializable

Serialized Fields

id

String id

name

String name

tag

String tag

Class com.mypurecloud.sdk.v2.model.NuanceBot

class NuanceBot extends Object implements Serializable

Serialized Fields

application

NuanceApplication application

channels

List<NuanceChannel> channels

credentials

List<NuanceBotCredentials> credentials

geography

NuanceGeography geography

id

String id

integrationId

String integrationId

locales

List<String> locales

name

String name

nuanceEnvironment

NuanceEnvironment nuanceEnvironment

nuanceOrganization

NuanceOrganization nuanceOrganization

selfUri

String selfUri

transferNodes

List<NuanceBotTransferNode> transferNodes

variables

List<NuanceBotVariable> variables

Class com.mypurecloud.sdk.v2.model.NuanceBotCredentials

class NuanceBotCredentials extends Object implements Serializable

Serialized Fields

appId

String appId

clientId

String clientId

clientSecret

String clientSecret

clientSecretProvided

Boolean clientSecretProvided

Class com.mypurecloud.sdk.v2.model.NuanceBotEntityListing

class NuanceBotEntityListing extends Object implements Serializable

Serialized Fields

entities

List<NuanceBot> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.NuanceBotLaunchSettings

class NuanceBotLaunchSettings extends Object implements Serializable

Serialized Fields

botExecutionConfigurations

List<BotExecutionConfiguration> botExecutionConfigurations

Class com.mypurecloud.sdk.v2.model.NuanceBotTransferNode

class NuanceBotTransferNode extends Object implements Serializable

Serialized Fields

description

String description

id

String id

name

String name

requestVariables

List<NuanceBotVariable> requestVariables

type

NuanceBotTransferNode.TypeEnum type

Class com.mypurecloud.sdk.v2.model.NuanceBotVariable

class NuanceBotVariable extends Object implements Serializable

Serialized Fields

complexGenericVariableInfo

ComplexVariableInfo complexGenericVariableInfo

description

String description

id

String id

name

String name

reserved

Boolean reserved

simpleVariableInfo

String simpleVariableInfo

Class com.mypurecloud.sdk.v2.model.NuanceChannel

class NuanceChannel extends Object implements Serializable

Serialized Fields

color

String color

id

String id

modes

List<String> modes

name

String name

Class com.mypurecloud.sdk.v2.model.NuanceEnvironment

class NuanceEnvironment extends Object implements Serializable

Serialized Fields

environmentDesignation

String environmentDesignation

executionHost

String executionHost

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.NuanceGeography

class NuanceGeography extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.NuanceMixDlgSettings

class NuanceMixDlgSettings extends Object implements Serializable

Serialized Fields

channelId

String channelId

inputParameters

Map<String,Object> inputParameters

Class com.mypurecloud.sdk.v2.model.NuanceOrganization

class NuanceOrganization extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.Number

class Number extends Object implements Serializable

Serialized Fields

end

String end

start

String start

Class com.mypurecloud.sdk.v2.model.NumberPlan

class NumberPlan extends Object implements Serializable

Serialized Fields

classification

String classification

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

digitLength

DigitLength digitLength

division

Division division

id

String id

match

String match

matchType

String matchType

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

normalizedFormat

String normalizedFormat

numbers

List<Number> numbers

priority

Integer priority

selfUri

String selfUri

state

NumberPlan.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.NumericRange

class NumericRange extends Object implements Serializable

Serialized Fields

gt

BigDecimal gt

gte

BigDecimal gte

lt

BigDecimal lt

lte

BigDecimal lte

Class com.mypurecloud.sdk.v2.model.OAuthAuthorization

class OAuthAuthorization extends Object implements Serializable

Serialized Fields

client

OAuthClient client

createdBy

DomainEntityRef createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

modifiedBy

DomainEntityRef modifiedBy

pending

Boolean pending

resourceOwner

DomainEntityRef resourceOwner

roles

List<String> roles

scope

List<String> scope

selfUri

String selfUri

state

OAuthAuthorization.StateEnum state

Class com.mypurecloud.sdk.v2.model.OAuthAuthorizationListing

class OAuthAuthorizationListing extends Object implements Serializable

Serialized Fields

entities

List<OAuthAuthorization> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.OAuthClient

class OAuthClient extends Object implements Serializable

Serialized Fields

accessTokenValiditySeconds

Long accessTokenValiditySeconds

authorizedGrantType

OAuthClient.AuthorizedGrantTypeEnum authorizedGrantType

createdBy

DomainEntityRef createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

dateToDelete

Date dateToDelete

description

String description

id

String id

modifiedBy

DomainEntityRef modifiedBy

name

String name

registeredRedirectUri

List<String> registeredRedirectUri

roleDivisions

List<RoleDivision> roleDivisions

roleIds

List<String> roleIds

scope

List<String> scope

secret

String secret

selfUri

String selfUri

state

OAuthClient.StateEnum state

Class com.mypurecloud.sdk.v2.model.OAuthClientEntityListing

class OAuthClientEntityListing extends Object implements Serializable

Serialized Fields

entities

List<OAuthClientListing> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.OAuthClientListing

class OAuthClientListing extends Object implements Serializable

Serialized Fields

accessTokenValiditySeconds

Long accessTokenValiditySeconds

createdBy

DomainEntityRef createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

dateToDelete

Date dateToDelete

description

String description

id

String id

modifiedBy

DomainEntityRef modifiedBy

name

String name

registeredRedirectUri

List<String> registeredRedirectUri

roleDivisions

List<RoleDivision> roleDivisions

roleIds

List<String> roleIds

scope

List<String> scope

secret

String secret

selfUri

String selfUri

state

OAuthClientListing.StateEnum state

Class com.mypurecloud.sdk.v2.model.OAuthClientRequest

class OAuthClientRequest extends Object implements Serializable

Serialized Fields

accessTokenValiditySeconds

Long accessTokenValiditySeconds

authorizedGrantType

OAuthClientRequest.AuthorizedGrantTypeEnum authorizedGrantType

dateToDelete

Date dateToDelete

description

String description

name

String name

registeredRedirectUri

List<String> registeredRedirectUri

roleDivisions

List<RoleDivision> roleDivisions

roleIds

List<String> roleIds

scope

List<String> scope

state

OAuthClientRequest.StateEnum state

Class com.mypurecloud.sdk.v2.model.OAuthLastTokenIssued

class OAuthLastTokenIssued extends Object implements Serializable

Serialized Fields

dateIssued

Date dateIssued

Class com.mypurecloud.sdk.v2.model.OAuthProvider

class OAuthProvider extends Object implements Serializable

Serialized Fields

disabled

Boolean disabled

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.OAuthProviderEntityListing

class OAuthProviderEntityListing extends Object implements Serializable

Serialized Fields

entities

List<OAuthProvider> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.OAuthScope

class OAuthScope extends Object implements Serializable

Serialized Fields

description

String description

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.OAuthScopeListing

class OAuthScopeListing extends Object implements Serializable

Serialized Fields

entities

List<OAuthScope> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.Objective

class Objective extends Object implements Serializable

Serialized Fields

dateStart

LocalDate dateStart

enabled

Boolean enabled

id

String id

mediaTypes

List<Objective.MediaTypesEnum> mediaTypes

queues

List<AddressableEntityRef> queues

templateId

String templateId

topicIdsFilterType

Objective.TopicIdsFilterTypeEnum topicIdsFilterType

topics

List<AddressableEntityRef> topics

zones

List<ObjectiveZone> zones

Class com.mypurecloud.sdk.v2.model.ObjectiveTemplate

class ObjectiveTemplate extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

zones

List<ObjectiveZone> zones

Class com.mypurecloud.sdk.v2.model.ObjectiveZone

class ObjectiveZone extends Object implements Serializable

Serialized Fields

directionType

ObjectiveZone.DirectionTypeEnum directionType

label

String label

lowerLimitPoints

Integer lowerLimitPoints

lowerLimitValue

Integer lowerLimitValue

upperLimitPoints

Integer upperLimitPoints

upperLimitValue

Integer upperLimitValue

zoneType

ObjectiveZone.ZoneTypeEnum zoneType

Class com.mypurecloud.sdk.v2.model.ObservationMetricData

class ObservationMetricData extends Object implements Serializable

Serialized Fields

metric

String metric

observations

List<ObservationValue> observations

qualifier

String qualifier

stats

StatisticalSummary stats

truncated

Boolean truncated

Class com.mypurecloud.sdk.v2.model.ObservationValue

class ObservationValue extends Object implements Serializable

Serialized Fields

addressFrom

String addressFrom

addressTo

String addressTo

ani

String ani

conversationId

String conversationId

convertedFrom

String convertedFrom

convertedTo

String convertedTo

direction

ObservationValue.DirectionEnum direction

dnis

String dnis

observationDate

Date observationDate

participantName

String participantName

requestedLanguageId

String requestedLanguageId

requestedRoutings

List<ObservationValue.RequestedRoutingsEnum> requestedRoutings

requestedRoutingSkillIds

List<String> requestedRoutingSkillIds

routingPriority

Long routingPriority

scoredAgents

List<AnalyticsScoredAgent> scoredAgents

sessionId

String sessionId

teamId

String teamId

usedRouting

ObservationValue.UsedRoutingEnum usedRouting

userId

String userId

Class com.mypurecloud.sdk.v2.model.Okta

class Okta extends Object implements Serializable

Serialized Fields

certificate

String certificate

certificates

List<String> certificates

disabled

Boolean disabled

id

String id

issuerURI

String issuerURI

name

String name

relyingPartyIdentifier

String relyingPartyIdentifier

selfUri

String selfUri

sloBinding

String sloBinding

sloURI

String sloURI

ssoTargetURI

String ssoTargetURI

Class com.mypurecloud.sdk.v2.model.OneLogin

class OneLogin extends Object implements Serializable

Serialized Fields

certificate

String certificate

certificates

List<String> certificates

disabled

Boolean disabled

id

String id

issuerURI

String issuerURI

name

String name

relyingPartyIdentifier

String relyingPartyIdentifier

selfUri

String selfUri

sloBinding

String sloBinding

sloURI

String sloURI

ssoTargetURI

String ssoTargetURI

Class com.mypurecloud.sdk.v2.model.OpenActionFields

class OpenActionFields extends Object implements Serializable

Serialized Fields

configurationFields

Map<String,Object> configurationFields

openAction

DomainEntityRef openAction

Class com.mypurecloud.sdk.v2.model.OpenIntegration

class OpenIntegration extends Object implements Serializable

Serialized Fields

createdBy

DomainEntityRef createdBy

createError

ErrorBody createError

createStatus

OpenIntegration.CreateStatusEnum createStatus

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

messagingSetting

MessagingSettingReference messagingSetting

modifiedBy

DomainEntityRef modifiedBy

name

String name

outboundNotificationWebhookSignatureSecretToken

String outboundNotificationWebhookSignatureSecretToken

outboundNotificationWebhookUrl

String outboundNotificationWebhookUrl

recipient

DomainEntityRef recipient

selfUri

String selfUri

status

String status

supportedContent

SupportedContentReference supportedContent

webhookHeaders

Map<String,String> webhookHeaders

Class com.mypurecloud.sdk.v2.model.OpenIntegrationEntityListing

class OpenIntegrationEntityListing extends Object implements Serializable

Serialized Fields

entities

List<OpenIntegration> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.OpenIntegrationRequest

class OpenIntegrationRequest extends Object implements Serializable

Serialized Fields

id

String id

messagingSetting

MessagingSettingRequestReference messagingSetting

name

String name

outboundNotificationWebhookSignatureSecretToken

String outboundNotificationWebhookSignatureSecretToken

outboundNotificationWebhookUrl

String outboundNotificationWebhookUrl

selfUri

String selfUri

supportedContent

SupportedContentReference supportedContent

webhookHeaders

Map<String,String> webhookHeaders

Class com.mypurecloud.sdk.v2.model.OpenIntegrationUpdateRequest

class OpenIntegrationUpdateRequest extends Object implements Serializable

Serialized Fields

id

String id

messagingSetting

MessagingSettingRequestReference messagingSetting

name

String name

outboundNotificationWebhookSignatureSecretToken

String outboundNotificationWebhookSignatureSecretToken

outboundNotificationWebhookUrl

String outboundNotificationWebhookUrl

selfUri

String selfUri

supportedContent

SupportedContentReference supportedContent

webhookHeaders

Map<String,String> webhookHeaders

Class com.mypurecloud.sdk.v2.model.OpenMessageContent

class OpenMessageContent extends Object implements Serializable

Serialized Fields

attachment

ConversationContentAttachment attachment

contentType

OpenMessageContent.ContentTypeEnum contentType

Class com.mypurecloud.sdk.v2.model.OpenMessagingChannel

class OpenMessagingChannel extends Object implements Serializable

Serialized Fields

from

OpenMessagingFromRecipient from

id

String id

messageId

String messageId

metadata

Object metadata

platform

OpenMessagingChannel.PlatformEnum platform

time

Date time

to

OpenMessagingToRecipient to

type

OpenMessagingChannel.TypeEnum type

Class com.mypurecloud.sdk.v2.model.OpenMessagingFromRecipient

class OpenMessagingFromRecipient extends Object implements Serializable

Serialized Fields

email

String email

firstName

String firstName

id

String id

idType

OpenMessagingFromRecipient.IdTypeEnum idType

image

String image

lastName

String lastName

nickname

String nickname

Class com.mypurecloud.sdk.v2.model.OpenMessagingToRecipient

class OpenMessagingToRecipient extends Object implements Serializable

Serialized Fields

email

String email

firstName

String firstName

id

String id

idType

OpenMessagingToRecipient.IdTypeEnum idType

image

String image

lastName

String lastName

nickname

String nickname

Class com.mypurecloud.sdk.v2.model.OpenNormalizedMessage

class OpenNormalizedMessage extends Object implements Serializable

Serialized Fields

channel

OpenMessagingChannel channel

content

List<OpenMessageContent> content

direction

OpenNormalizedMessage.DirectionEnum direction

id

String id

isFinalReceipt

Boolean isFinalReceipt

metadata

Map<String,String> metadata

reasons

List<ConversationReason> reasons

status

OpenNormalizedMessage.StatusEnum status

text

String text

type

OpenNormalizedMessage.TypeEnum type

Class com.mypurecloud.sdk.v2.model.Operation

class Operation extends Object implements Serializable

Serialized Fields

actionName

Operation.ActionNameEnum actionName

actionStatus

Operation.ActionStatusEnum actionStatus

client

DomainEntityRef client

complete

Boolean complete

errorCode

String errorCode

errorDetails

List<Detail> errorDetails

errorMessage

String errorMessage

errorMessageParams

Map<String,String> errorMessageParams

id

String id

user

User user

Class com.mypurecloud.sdk.v2.model.OptInSettings

class OptInSettings extends Object implements Serializable

Serialized Fields

keyword

List<String> keyword

response

ComplianceResponse response

Class com.mypurecloud.sdk.v2.model.Organization

class Organization extends Object implements Serializable

Serialized Fields

defaultCountryCode

String defaultCountryCode

defaultLanguage

String defaultLanguage

defaultSiteId

String defaultSiteId

domain

String domain

features

Map<String,Boolean> features

id

String id

name

String name

productPlatform

Organization.ProductPlatformEnum productPlatform

selfUri

String selfUri

state

Organization.StateEnum state

supportURI

String supportURI

thirdPartyOrgName

String thirdPartyOrgName

thirdPartyURI

String thirdPartyURI

version

Integer version

voicemailEnabled

Boolean voicemailEnabled

Class com.mypurecloud.sdk.v2.model.OrganizationFeatures

class OrganizationFeatures extends Object implements Serializable

Serialized Fields

chat

Boolean chat

contactCenter

Boolean contactCenter

custserv

Boolean custserv

directory

Boolean directory

hipaa

Boolean hipaa

informalPhotos

Boolean informalPhotos

pci

Boolean pci

purecloud

Boolean purecloud

purecloudVoice

Boolean purecloudVoice

realtimeCIC

Boolean realtimeCIC

ucEnabled

Boolean ucEnabled

unifiedCommunications

Boolean unifiedCommunications

xmppFederation

Boolean xmppFederation

Class com.mypurecloud.sdk.v2.model.OrganizationPresence

class OrganizationPresence extends Object implements Serializable

Serialized Fields

createdBy

User createdBy

createdDate

Date createdDate

deactivated

Boolean deactivated

id

String id

languageLabels

Map<String,String> languageLabels

modifiedBy

User modifiedBy

modifiedDate

Date modifiedDate

name

String name

primary

Boolean primary

selfUri

String selfUri

systemPresence

String systemPresence

Class com.mypurecloud.sdk.v2.model.OrganizationPresenceDefinition

class OrganizationPresenceDefinition extends Object implements Serializable

Serialized Fields

deactivated

Boolean deactivated

divisionId

String divisionId

id

String id

languageLabels

Map<String,String> languageLabels

name

String name

selfUri

String selfUri

systemPresence

OrganizationPresenceDefinition.SystemPresenceEnum systemPresence

type

OrganizationPresenceDefinition.TypeEnum type

Class com.mypurecloud.sdk.v2.model.OrganizationPresenceDefinitionEntityListing

class OrganizationPresenceDefinitionEntityListing extends Object implements Serializable

Serialized Fields

entities

List<OrganizationPresenceDefinition> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.OrganizationPresenceEntityListing

class OrganizationPresenceEntityListing extends Object implements Serializable

Serialized Fields

entities

List<OrganizationPresence> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.OrganizationProductEntityListing

class OrganizationProductEntityListing extends Object implements Serializable

Serialized Fields

entities

List<DomainOrganizationProduct> entities

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

total

Long total

Class com.mypurecloud.sdk.v2.model.OrganizationRoleEntityListing

class OrganizationRoleEntityListing extends Object implements Serializable

Serialized Fields

entities

List<DomainOrganizationRole> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.OrgAuthSettings

class OrgAuthSettings extends Object implements Serializable

Serialized Fields

domainAllowlist

List<String> domainAllowlist

domainAllowlistEnabled

Boolean domainAllowlistEnabled

ipAddressAllowlist

List<String> ipAddressAllowlist

multifactorAuthenticationRequired

Boolean multifactorAuthenticationRequired

passwordRequirements

PasswordRequirements passwordRequirements

Class com.mypurecloud.sdk.v2.model.OrgOAuthClient

class OrgOAuthClient extends Object implements Serializable

Serialized Fields

authorizedGrantType

OrgOAuthClient.AuthorizedGrantTypeEnum authorizedGrantType

createdBy

DomainEntityRef createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

dateToDelete

Date dateToDelete

id

String id

modifiedBy

DomainEntityRef modifiedBy

name

String name

organization

NamedEntity organization

roleDivisions

List<RoleDivision> roleDivisions

scope

List<String> scope

state

OrgOAuthClient.StateEnum state

Class com.mypurecloud.sdk.v2.model.OrgUser

class OrgUser extends Object implements Serializable

Serialized Fields

acdAutoAnswer

Boolean acdAutoAnswer

addresses

List<Contact> addresses

authorization

UserAuthorization authorization

biography

Biography biography

certifications

List<String> certifications

chat

Chat chat

conversationSummary

UserConversationSummary conversationSummary

dateLastLogin

Date dateLastLogin

department

String department

division

Division division

email

String email

employerInfo

EmployerInfo employerInfo

geolocation

Geolocation geolocation

groups

List<Group> groups

id

String id

images

List<UserImage> images

integrationPresence

UserPresence integrationPresence

languagePreference

String languagePreference

languages

List<UserRoutingLanguage> languages

lastTokenIssued

OAuthLastTokenIssued lastTokenIssued

locations

List<Location> locations

manager

User manager

name

String name

organization

Organization organization

outOfOffice

OutOfOffice outOfOffice

presence

UserPresence presence

primaryContactInfo

List<Contact> primaryContactInfo

profileSkills

List<String> profileSkills

routingStatus

RoutingStatus routingStatus

skills

List<UserRoutingSkill> skills

state

OrgUser.StateEnum state

station

UserStations station

team

Team team

title

String title

username

String username

version

Integer version

Class com.mypurecloud.sdk.v2.model.OrgWhitelistSettings

class OrgWhitelistSettings extends Object implements Serializable

Serialized Fields

domainWhitelist

List<String> domainWhitelist

enableWhitelist

Boolean enableWhitelist

Class com.mypurecloud.sdk.v2.model.OrphanRecording

class OrphanRecording extends Object implements Serializable

Serialized Fields

createdTime

Date createdTime

fileState

OrphanRecording.FileStateEnum fileState

id

String id

mediaSizeBytes

Long mediaSizeBytes

mediaType

OrphanRecording.MediaTypeEnum mediaType

name

String name

orphanStatus

OrphanRecording.OrphanStatusEnum orphanStatus

providerEndpoint

Endpoint providerEndpoint

providerType

OrphanRecording.ProviderTypeEnum providerType

recording

Recording recording

recoveredTime

Date recoveredTime

region

OrphanRecording.RegionEnum region

selfUri

String selfUri

sourceOrphaningId

String sourceOrphaningId

Class com.mypurecloud.sdk.v2.model.OrphanRecordingListing

class OrphanRecordingListing extends Object implements Serializable

Serialized Fields

entities

List<OrphanRecording> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.OrphanUpdateRequest

class OrphanUpdateRequest extends Object implements Serializable

Serialized Fields

archiveDate

Date archiveDate

conversationId

String conversationId

deleteDate

Date deleteDate

exportDate

Date exportDate

integrationId

String integrationId

Class com.mypurecloud.sdk.v2.model.OtherProfileAssignment

class OtherProfileAssignment extends Object implements Serializable

Serialized Fields

currentProfile

DomainEntityRef currentProfile

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.OutboundDetailEventTopicOutboundInitEvent

class OutboundDetailEventTopicOutboundInitEvent extends Object implements Serializable

Serialized Fields

addressFrom

String addressFrom

addressTo

String addressTo

ani

String ani

conversationExternalContactIds

List<String> conversationExternalContactIds

conversationExternalOrganizationIds

List<String> conversationExternalOrganizationIds

conversationId

String conversationId

direction

OutboundDetailEventTopicOutboundInitEvent.DirectionEnum direction

divisionId

String divisionId

dnis

String dnis

eventTime

Integer eventTime

mediaType

OutboundDetailEventTopicOutboundInitEvent.MediaTypeEnum mediaType

messageType

OutboundDetailEventTopicOutboundInitEvent.MessageTypeEnum messageType

outboundCampaignId

String outboundCampaignId

outboundContactId

String outboundContactId

outboundContactListId

String outboundContactListId

participantId

String participantId

provider

String provider

sessionId

String sessionId

subject

String subject

Class com.mypurecloud.sdk.v2.model.OutboundDomain

class OutboundDomain extends Object implements Serializable

Serialized Fields

cnameVerificationResult

VerificationResult cnameVerificationResult

dkimVerificationResult

VerificationResult dkimVerificationResult

id

String id

name

String name

selfUri

String selfUri

senderType

OutboundDomain.SenderTypeEnum senderType

Class com.mypurecloud.sdk.v2.model.OutboundDomainEntityListing

class OutboundDomainEntityListing extends Object implements Serializable

Serialized Fields

entities

List<OutboundDomain> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.OutboundMessagingMessagingCampaignConfigChangeContactSort

class OutboundMessagingMessagingCampaignConfigChangeContactSort extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

direction

OutboundMessagingMessagingCampaignConfigChangeContactSort.DirectionEnum direction

fieldName

String fieldName

numeric

Boolean numeric

Class com.mypurecloud.sdk.v2.model.OutboundMessagingMessagingCampaignConfigChangeEmailConfig

class OutboundMessagingMessagingCampaignConfigChangeEmailConfig extends Object implements Serializable

Serialized Fields

contentTemplate

OutboundMessagingMessagingCampaignConfigChangeResponseRef contentTemplate

emailColumns

List<String> emailColumns

fromAddress

OutboundMessagingMessagingCampaignConfigChangeFromEmailAddress fromAddress

replyToAddress

OutboundMessagingMessagingCampaignConfigChangeReplyToEmailAddress replyToAddress

Class com.mypurecloud.sdk.v2.model.OutboundMessagingMessagingCampaignConfigChangeErrorDetail

class OutboundMessagingMessagingCampaignConfigChangeErrorDetail extends Object implements Serializable

Serialized Fields

details

String details

error

String error

Class com.mypurecloud.sdk.v2.model.OutboundMessagingMessagingCampaignConfigChangeFromEmailAddress

class OutboundMessagingMessagingCampaignConfigChangeFromEmailAddress extends Object implements Serializable

Serialized Fields

domain

OutboundMessagingMessagingCampaignConfigChangeUriReference domain

friendlyName

String friendlyName

localPart

String localPart

Class com.mypurecloud.sdk.v2.model.OutboundMessagingMessagingCampaignConfigChangeMessagingCampaign

class OutboundMessagingMessagingCampaignConfigChangeMessagingCampaign extends Object implements Serializable

Serialized Fields

alwaysRunning

Boolean alwaysRunning

callableTimeSet

OutboundMessagingMessagingCampaignConfigChangeUriReference callableTimeSet

campaignStatus

OutboundMessagingMessagingCampaignConfigChangeMessagingCampaign.CampaignStatusEnum campaignStatus

contactList

OutboundMessagingMessagingCampaignConfigChangeUriReference contactList

contactListFilters

List<OutboundMessagingMessagingCampaignConfigChangeUriReference> contactListFilters

contactSorts

List<OutboundMessagingMessagingCampaignConfigChangeContactSort> contactSorts

dateCreated

Date dateCreated

dateModified

Date dateModified

division

OutboundMessagingMessagingCampaignConfigChangeUriReference division

dncLists

List<OutboundMessagingMessagingCampaignConfigChangeUriReference> dncLists

emailConfig

OutboundMessagingMessagingCampaignConfigChangeEmailConfig emailConfig

errors

List<OutboundMessagingMessagingCampaignConfigChangeErrorDetail> errors

id

String id

messagesPerMinute

Integer messagesPerMinute

name

String name

ruleSets

List<OutboundMessagingMessagingCampaignConfigChangeUriReference> ruleSets

smsConfig

OutboundMessagingMessagingCampaignConfigChangeSmsConfig smsConfig

version

Integer version

Class com.mypurecloud.sdk.v2.model.OutboundMessagingMessagingCampaignConfigChangeObject

class OutboundMessagingMessagingCampaignConfigChangeObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.OutboundMessagingMessagingCampaignConfigChangeReplyToEmailAddress

class OutboundMessagingMessagingCampaignConfigChangeReplyToEmailAddress extends Object implements Serializable

Serialized Fields

domain

OutboundMessagingMessagingCampaignConfigChangeUriReference domain

route

OutboundMessagingMessagingCampaignConfigChangeUriReference route

Class com.mypurecloud.sdk.v2.model.OutboundMessagingMessagingCampaignConfigChangeResponseRef

class OutboundMessagingMessagingCampaignConfigChangeResponseRef extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.OutboundMessagingMessagingCampaignConfigChangeSmsConfig

class OutboundMessagingMessagingCampaignConfigChangeSmsConfig extends Object implements Serializable

Serialized Fields

contentTemplate

OutboundMessagingMessagingCampaignConfigChangeResponseRef contentTemplate

messageColumn

String messageColumn

phoneColumn

String phoneColumn

senderSmsPhoneNumber

OutboundMessagingMessagingCampaignConfigChangeSmsPhoneNumberRef senderSmsPhoneNumber

Class com.mypurecloud.sdk.v2.model.OutboundMessagingMessagingCampaignConfigChangeSmsPhoneNumberRef

class OutboundMessagingMessagingCampaignConfigChangeSmsPhoneNumberRef extends Object implements Serializable

Serialized Fields

phoneNumber

String phoneNumber

Class com.mypurecloud.sdk.v2.model.OutboundMessagingMessagingCampaignConfigChangeUriReference

class OutboundMessagingMessagingCampaignConfigChangeUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.OutboundMessagingMessagingCampaignProgressEventCampaignProgress

class OutboundMessagingMessagingCampaignProgressEventCampaignProgress extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

campaign

OutboundMessagingMessagingCampaignProgressEventUriReference campaign

numberOfContactsCalled

BigDecimal numberOfContactsCalled

numberOfContactsMessaged

BigDecimal numberOfContactsMessaged

percentage

Integer percentage

totalNumberOfContacts

BigDecimal totalNumberOfContacts

Class com.mypurecloud.sdk.v2.model.OutboundMessagingMessagingCampaignProgressEventObject

class OutboundMessagingMessagingCampaignProgressEventObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.OutboundMessagingMessagingCampaignProgressEventUriReference

class OutboundMessagingMessagingCampaignProgressEventUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.OutboundRoute

class OutboundRoute extends Object implements Serializable

Serialized Fields

classificationTypes

List<String> classificationTypes

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

distribution

OutboundRoute.DistributionEnum distribution

division

Division division

enabled

Boolean enabled

externalTrunkBases

List<DomainEntityRef> externalTrunkBases

id

String id

managed

Boolean managed

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

selfUri

String selfUri

site

Site site

state

OutboundRoute.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.OutboundRouteBase

class OutboundRouteBase extends Object implements Serializable

Serialized Fields

classificationTypes

List<String> classificationTypes

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

distribution

OutboundRouteBase.DistributionEnum distribution

division

Division division

enabled

Boolean enabled

externalTrunkBases

List<DomainEntityRef> externalTrunkBases

id

String id

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

selfUri

String selfUri

state

OutboundRouteBase.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.OutboundRouteBaseEntityListing

class OutboundRouteBaseEntityListing extends Object implements Serializable

Serialized Fields

entities

List<OutboundRouteBase> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.OutboundRouteEntityListing

class OutboundRouteEntityListing extends Object implements Serializable

Serialized Fields

entities

List<OutboundRoute> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.OutboundSettings

class OutboundSettings extends Object implements Serializable

Serialized Fields

abandonSeconds

Double abandonSeconds

automaticTimeZoneMapping

AutomaticTimeZoneMappingSettings automaticTimeZoneMapping

complianceAbandonRateDenominator

OutboundSettings.ComplianceAbandonRateDenominatorEnum complianceAbandonRateDenominator

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

maxCallsPerAgent

Integer maxCallsPerAgent

maxConfigurableCallsPerAgent

Integer maxConfigurableCallsPerAgent

maxLineUtilization

Double maxLineUtilization

name

String name

rescheduleTimeZoneSkippedContacts

Boolean rescheduleTimeZoneSkippedContacts

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.Outcome

class Outcome extends Object implements Serializable

Serialized Fields

associatedValueField

AssociatedValueField associatedValueField

context

Context context

createdDate

Date createdDate

description

String description

displayName

String displayName

id

String id

isActive

Boolean isActive

isPositive

Boolean isPositive

journey

Journey journey

modifiedDate

Date modifiedDate

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.OutcomeAchievedEvent

class OutcomeAchievedEvent extends Object implements Serializable

Serialized Fields

browser

Browser browser

device

Device device

geolocation

JourneyGeolocation geolocation

ipAddress

String ipAddress

ipOrganization

String ipOrganization

mktCampaign

JourneyCampaign mktCampaign

outcome

OutcomeAchievedEventOutcome outcome

userAgentString

String userAgentString

visitCreatedDate

Date visitCreatedDate

visitReferrer

Referrer visitReferrer

Class com.mypurecloud.sdk.v2.model.OutcomeAchievedEventOutcome

class OutcomeAchievedEventOutcome extends Object implements Serializable

Serialized Fields

displayName

String displayName

id

String id

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.OutcomeAchievement

class OutcomeAchievement extends Object implements Serializable

Serialized Fields

achievedDate

Date achievedDate

outcome

AchievedOutcome outcome

Class com.mypurecloud.sdk.v2.model.OutcomeAttributionAsyncResponse

class OutcomeAttributionAsyncResponse extends Object implements Serializable

Serialized Fields

id

String id

percentFailedThreshold

Integer percentFailedThreshold

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.OutcomeAttributionJobStateResponse

class OutcomeAttributionJobStateResponse extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

id

String id

percentFailedThreshold

Integer percentFailedThreshold

resultsUri

String resultsUri

selfUri

String selfUri

state

OutcomeAttributionJobStateResponse.StateEnum state

Class com.mypurecloud.sdk.v2.model.OutcomeAttributionListing

class OutcomeAttributionListing extends Object implements Serializable

Serialized Fields

entities

List<OutcomeAttributionRequest> entities

percentFailedThreshold

Integer percentFailedThreshold

Class com.mypurecloud.sdk.v2.model.OutcomeAttributionRequest

class OutcomeAttributionRequest extends Object implements Serializable

Serialized Fields

associatedValue

BigDecimal associatedValue

createdDate

Date createdDate

externalContactId

String externalContactId

outcomeId

String outcomeId

touchpoints

List<Touchpoint> touchpoints

Class com.mypurecloud.sdk.v2.model.OutcomeAttributionResponseListing

class OutcomeAttributionResponseListing extends Object implements Serializable

Serialized Fields

entities

List<OutcomeAttributionResultsResponse> entities

Class com.mypurecloud.sdk.v2.model.OutcomeAttributionResultsResponse

class OutcomeAttributionResultsResponse extends Object implements Serializable

Serialized Fields

associatedValue

BigDecimal associatedValue

createdDate

Date createdDate

externalContactId

String externalContactId

index

Integer index

message

String message

outcomeId

String outcomeId

state

OutcomeAttributionResultsResponse.StateEnum state

touchpoints

List<TouchpointResponse> touchpoints

Class com.mypurecloud.sdk.v2.model.OutcomeConfig

class OutcomeConfig extends Object implements Serializable

Serialized Fields

values

List<String> values

Class com.mypurecloud.sdk.v2.model.OutcomeEventScore

class OutcomeEventScore extends Object implements Serializable

Serialized Fields

outcome

AddressableEntityRef outcome

percentile

Integer percentile

probability

Float probability

sessionMaxPercentile

Integer sessionMaxPercentile

sessionMaxProbability

Float sessionMaxProbability

Class com.mypurecloud.sdk.v2.model.OutcomeListing

class OutcomeListing extends Object implements Serializable

Serialized Fields

entities

List<Outcome> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.OutcomePercentileCondition

class OutcomePercentileCondition extends Object implements Serializable

Serialized Fields

fallbackPercentile

Float fallbackPercentile

maximumPercentile

Float maximumPercentile

outcomeId

String outcomeId

Class com.mypurecloud.sdk.v2.model.OutcomePredictor

class OutcomePredictor extends Object implements Serializable

Serialized Fields

id

String id

outcome

OutcomeRef outcome

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.OutcomePredictorListing

class OutcomePredictorListing extends Object implements Serializable

Serialized Fields

entities

List<OutcomePredictor> entities

Class com.mypurecloud.sdk.v2.model.OutcomePredictorRequest

class OutcomePredictorRequest extends Object implements Serializable

Serialized Fields

outcome

OutcomeRefRequest outcome

Class com.mypurecloud.sdk.v2.model.OutcomeProbabilityCondition

class OutcomeProbabilityCondition extends Object implements Serializable

Serialized Fields

maximumProbability

Float maximumProbability

outcomeId

String outcomeId

probability

Float probability

Class com.mypurecloud.sdk.v2.model.OutcomeRef

class OutcomeRef extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.OutcomeRefRequest

class OutcomeRefRequest extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.OutcomeScoresResult

class OutcomeScoresResult extends Object implements Serializable

Serialized Fields

modifiedDate

Date modifiedDate

outcomeScores

List<OutcomeEventScore> outcomeScores

Class com.mypurecloud.sdk.v2.model.OutOfOffice

class OutOfOffice extends Object implements Serializable

Serialized Fields

active

Boolean active

endDate

Date endDate

id

String id

indefinite

Boolean indefinite

name

String name

selfUri

String selfUri

startDate

Date startDate

user

User user

Class com.mypurecloud.sdk.v2.model.OutOfOfficeEventOutOfOffice

class OutOfOfficeEventOutOfOffice extends Object implements Serializable

Serialized Fields

active

Boolean active

endDate

Date endDate

indefinite

Boolean indefinite

startDate

Date startDate

user

OutOfOfficeEventUser user

Class com.mypurecloud.sdk.v2.model.OutOfOfficeEventUser

class OutOfOfficeEventUser extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.OverallBestPoints

class OverallBestPoints extends Object implements Serializable

Serialized Fields

bestPoints

List<OverallBestPointsItem> bestPoints

division

Division division

performanceProfile

AddressableEntityRef performanceProfile

Class com.mypurecloud.sdk.v2.model.OverallBestPointsItem

class OverallBestPointsItem extends Object implements Serializable

Serialized Fields

count

Integer count

dateEndWorkday

LocalDate dateEndWorkday

dateStartWorkday

LocalDate dateStartWorkday

granularityType

OverallBestPointsItem.GranularityTypeEnum granularityType

points

Integer points

users

List<UserReference> users

Class com.mypurecloud.sdk.v2.model.Page

class Page extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

id

String id

modifiedDate

Date modifiedDate

name

String name

properties

Map<String,Object> properties

rootContainer

Map<String,Object> rootContainer

selfUri

String selfUri

versionId

String versionId

Class com.mypurecloud.sdk.v2.model.PagedNamespaceListing

class PagedNamespaceListing extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.PagelessDomainEntityListingEvaluationVersion

class PagelessDomainEntityListingEvaluationVersion extends Object implements Serializable

Serialized Fields

entities

List<EvaluationVersion> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.PagingSpec

class PagingSpec extends Object implements Serializable

Serialized Fields

pageNumber

Integer pageNumber

pageSize

Integer pageSize

Class com.mypurecloud.sdk.v2.model.Parameter

class Parameter extends Object implements Serializable

Serialized Fields

domain

Parameter.DomainEnum domain

name

String name

parameterType

Parameter.ParameterTypeEnum parameterType

required

Boolean required

Class com.mypurecloud.sdk.v2.model.ParsedCertificate

class ParsedCertificate extends Object implements Serializable

Serialized Fields

certificateDetails

List<CertificateDetails> certificateDetails

Class com.mypurecloud.sdk.v2.model.Participant

class Participant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

ani

String ani

aniName

String aniName

attributes

Map<String,String> attributes

bargedParticipantId

String bargedParticipantId

callbacks

List<Callback> callbacks

calls

List<Call> calls

chats

List<ConversationChat> chats

coachedParticipantId

String coachedParticipantId

cobrowsesessions

List<Cobrowsesession> cobrowsesessions

connectedTime

Date connectedTime

consultParticipantId

String consultParticipantId

conversationRoutingData

ConversationRoutingData conversationRoutingData

dnis

String dnis

emails

List<Email> emails

endAcwTime

Date endAcwTime

endTime

Date endTime

evaluations

List<Evaluation> evaluations

externalContactId

String externalContactId

externalOrganizationId

String externalOrganizationId

flaggedReason

Participant.FlaggedReasonEnum flaggedReason

groupId

String groupId

id

String id

locale

String locale

mediaRoles

List<String> mediaRoles

messages

List<Message> messages

monitoredParticipantId

String monitoredParticipantId

name

String name

participantType

String participantType

purpose

String purpose

queueId

String queueId

queueName

String queueName

screenRecordingState

Participant.ScreenRecordingStateEnum screenRecordingState

screenshares

List<Screenshare> screenshares

socialExpressions

List<SocialExpression> socialExpressions

startAcwTime

Date startAcwTime

startTime

Date startTime

teamId

String teamId

userId

String userId

userUri

String userUri

videos

List<Video> videos

wrapup

Wrapup wrapup

wrapupPrompt

Participant.WrapupPromptEnum wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.ParticipantAttributes

class ParticipantAttributes extends Object implements Serializable

Serialized Fields

attributes

Map<String,String> attributes

Class com.mypurecloud.sdk.v2.model.ParticipantBasic

class ParticipantBasic extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

ani

String ani

aniName

String aniName

attributes

Map<String,String> attributes

bargedParticipantId

String bargedParticipantId

callbacks

List<CallbackBasic> callbacks

calls

List<CallBasic> calls

chats

List<ConversationChat> chats

coachedParticipantId

String coachedParticipantId

cobrowsesessions

List<Cobrowsesession> cobrowsesessions

connectedTime

Date connectedTime

consultParticipantId

String consultParticipantId

conversationRoutingData

ConversationRoutingData conversationRoutingData

dnis

String dnis

emails

List<Email> emails

endAcwTime

Date endAcwTime

endTime

Date endTime

evaluations

List<Evaluation> evaluations

externalContactId

String externalContactId

externalOrganizationId

String externalOrganizationId

flaggedReason

ParticipantBasic.FlaggedReasonEnum flaggedReason

groupId

String groupId

id

String id

locale

String locale

mediaRoles

List<String> mediaRoles

messages

List<Message> messages

monitoredParticipantId

String monitoredParticipantId

name

String name

participantType

String participantType

purpose

String purpose

queueId

String queueId

queueName

String queueName

screenRecordingState

ParticipantBasic.ScreenRecordingStateEnum screenRecordingState

screenshares

List<Screenshare> screenshares

socialExpressions

List<SocialExpression> socialExpressions

startAcwTime

Date startAcwTime

startTime

Date startTime

teamId

String teamId

userId

String userId

userUri

String userUri

videos

List<Video> videos

wrapup

Wrapup wrapup

wrapupPrompt

ParticipantBasic.WrapupPromptEnum wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.ParticipantInfo

class ParticipantInfo extends Object implements Serializable

Serialized Fields

activeParticipantCount

Integer activeParticipantCount

version

Integer version

Class com.mypurecloud.sdk.v2.model.ParticipantMetrics

class ParticipantMetrics extends Object implements Serializable

Serialized Fields

acdDurationPercentage

Double acdDurationPercentage

agentDurationPercentage

Double agentDurationPercentage

customerDurationPercentage

Double customerDurationPercentage

ivrDurationPercentage

Double ivrDurationPercentage

otherDurationPercentage

Double otherDurationPercentage

overtalkCount

Integer overtalkCount

overtalkDurationPercentage

Double overtalkDurationPercentage

silenceDurationPercentage

Double silenceDurationPercentage

Class com.mypurecloud.sdk.v2.model.PasswordRequirements

class PasswordRequirements extends Object implements Serializable

Serialized Fields

expirationDays

Integer expirationDays

minimumAgeSeconds

Integer minimumAgeSeconds

minimumDigits

Integer minimumDigits

minimumLength

Integer minimumLength

minimumLetters

Integer minimumLetters

minimumLower

Integer minimumLower

minimumSpecials

Integer minimumSpecials

minimumUpper

Integer minimumUpper

Class com.mypurecloud.sdk.v2.model.PatchAction

class PatchAction extends Object implements Serializable

Serialized Fields

actionTargetId

String actionTargetId

actionTemplate

ActionMapActionTemplate actionTemplate

architectFlowFields

ArchitectFlowFields architectFlowFields

isPacingEnabled

Boolean isPacingEnabled

mediaType

PatchAction.MediaTypeEnum mediaType

openActionFields

OpenActionFields openActionFields

props

PatchActionProperties props

webMessagingOfferFields

PatchWebMessagingOfferFields webMessagingOfferFields

Class com.mypurecloud.sdk.v2.model.PatchActionMap

class PatchActionMap extends Object implements Serializable

Serialized Fields

action

PatchAction action

actionMapScheduleGroups

PatchActionMapScheduleGroups actionMapScheduleGroups

activation

Activation activation

createdDate

Date createdDate

displayName

String displayName

endDate

Date endDate

id

String id

ignoreFrequencyCap

Boolean ignoreFrequencyCap

isActive

Boolean isActive

modifiedDate

Date modifiedDate

pageUrlConditions

List<UrlCondition> pageUrlConditions

selfUri

String selfUri

startDate

Date startDate

triggerWithEventConditions

List<EventCondition> triggerWithEventConditions

triggerWithOutcomePercentileConditions

List<OutcomePercentileCondition> triggerWithOutcomePercentileConditions

triggerWithOutcomeProbabilityConditions

List<OutcomeProbabilityCondition> triggerWithOutcomeProbabilityConditions

triggerWithSegments

List<String> triggerWithSegments

version

Integer version

weight

Integer weight

Class com.mypurecloud.sdk.v2.model.PatchActionMapScheduleGroups

class PatchActionMapScheduleGroups extends Object implements Serializable

Serialized Fields

actionMapScheduleGroup

ActionMapScheduleGroup actionMapScheduleGroup

emergencyActionMapScheduleGroup

ActionMapScheduleGroup emergencyActionMapScheduleGroup

Class com.mypurecloud.sdk.v2.model.PatchActionProperties

class PatchActionProperties extends Object implements Serializable

Serialized Fields

webchatAcceptText

String webchatAcceptText

webchatDeclineText

String webchatDeclineText

webchatPrompt

String webchatPrompt

webchatSurvey

PatchActionSurvey webchatSurvey

webchatTitleText

String webchatTitleText

Class com.mypurecloud.sdk.v2.model.PatchActionSurvey

class PatchActionSurvey extends Object implements Serializable

Serialized Fields

questions

List<PatchSurveyQuestion> questions

Class com.mypurecloud.sdk.v2.model.PatchActionTarget

class PatchActionTarget extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

serviceLevel

ServiceLevel serviceLevel

shortAbandonThreshold

Integer shortAbandonThreshold

Class com.mypurecloud.sdk.v2.model.PatchActionTemplate

class PatchActionTemplate extends Object implements Serializable

Serialized Fields

contentOffer

PatchContentOffer contentOffer

description

String description

mediaType

PatchActionTemplate.MediaTypeEnum mediaType

name

String name

state

PatchActionTemplate.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.PatchBuReschedulingOptionsManagementUnitRequest

class PatchBuReschedulingOptionsManagementUnitRequest extends Object implements Serializable

Serialized Fields

applied

Boolean applied

managementUnitId

String managementUnitId

Class com.mypurecloud.sdk.v2.model.PatchBuReschedulingOptionsRequest

class PatchBuReschedulingOptionsRequest extends Object implements Serializable

Serialized Fields

managementUnits

List<PatchBuReschedulingOptionsManagementUnitRequest> managementUnits

Class com.mypurecloud.sdk.v2.model.PatchBuScheduleRunRequest

class PatchBuScheduleRunRequest extends Object implements Serializable

Serialized Fields

reschedulingOptions

PatchBuReschedulingOptionsRequest reschedulingOptions

Class com.mypurecloud.sdk.v2.model.PatchCallbackRequest

class PatchCallbackRequest extends Object implements Serializable

Serialized Fields

agentId

String agentId

callbackScheduledTime

Date callbackScheduledTime

conversationId

String conversationId

queueId

String queueId

Class com.mypurecloud.sdk.v2.model.PatchCallbackResponse

class PatchCallbackResponse extends Object implements Serializable

Serialized Fields

callbackIdentifiers

List<CallbackIdentifier> callbackIdentifiers

conversation

DomainEntityRef conversation

Class com.mypurecloud.sdk.v2.model.PatchCallToAction

class PatchCallToAction extends Object implements Serializable

Serialized Fields

target

PatchCallToAction.TargetEnum target

text

String text

url

String url

Class com.mypurecloud.sdk.v2.model.PatchCloseButtonStyleProperties

class PatchCloseButtonStyleProperties extends Object implements Serializable

Serialized Fields

color

String color

opacity

Float opacity

Class com.mypurecloud.sdk.v2.model.PatchContentOffer

class PatchContentOffer extends Object implements Serializable

Serialized Fields

body

String body

callToAction

PatchCallToAction callToAction

displayMode

PatchContentOffer.DisplayModeEnum displayMode

headline

String headline

imageUrl

String imageUrl

layoutMode

PatchContentOffer.LayoutModeEnum layoutMode

style

PatchContentOfferStylingConfiguration style

title

String title

Class com.mypurecloud.sdk.v2.model.PatchContentOfferStyleProperties

class PatchContentOfferStyleProperties extends Object implements Serializable

Serialized Fields

backgroundColor

String backgroundColor

color

String color

padding

String padding

Class com.mypurecloud.sdk.v2.model.PatchContentOfferStylingConfiguration

class PatchContentOfferStylingConfiguration extends Object implements Serializable

Serialized Fields

body

PatchTextStyleProperties body

closeButton

PatchCloseButtonStyleProperties closeButton

ctaButton

PatchCtaButtonStyleProperties ctaButton

headline

PatchTextStyleProperties headline

offer

PatchContentOfferStyleProperties offer

position

PatchContentPositionProperties position

title

PatchTextStyleProperties title

Class com.mypurecloud.sdk.v2.model.PatchContentPositionProperties

class PatchContentPositionProperties extends Object implements Serializable

Serialized Fields

bottom

String bottom

left

String left

right

String right

top

String top

Class com.mypurecloud.sdk.v2.model.PatchCtaButtonStyleProperties

class PatchCtaButtonStyleProperties extends Object implements Serializable

Serialized Fields

backgroundColor

String backgroundColor

color

String color

font

String font

fontSize

String fontSize

textAlign

PatchCtaButtonStyleProperties.TextAlignEnum textAlign

Class com.mypurecloud.sdk.v2.model.PatchExternalSegment

class PatchExternalSegment extends Object implements Serializable

Serialized Fields

name

String name

Class com.mypurecloud.sdk.v2.model.PatchIntegrationAction

class PatchIntegrationAction extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.PatchIntegrationActionFields

class PatchIntegrationActionFields extends Object implements Serializable

Serialized Fields

integrationAction

PatchIntegrationAction integrationAction

requestMappings

List<RequestMapping> requestMappings

Class com.mypurecloud.sdk.v2.model.PatchOutcome

class PatchOutcome extends Object implements Serializable

Serialized Fields

associatedValueField

AssociatedValueField associatedValueField

context

Context context

createdDate

Date createdDate

description

String description

displayName

String displayName

id

String id

isActive

Boolean isActive

isPositive

Boolean isPositive

journey

Journey journey

modifiedDate

Date modifiedDate

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.PatchPredictorRequest

class PatchPredictorRequest extends Object implements Serializable

Serialized Fields

routingTimeoutSeconds

Integer routingTimeoutSeconds

schedule

PredictorSchedule schedule

workloadBalancingConfig

PredictorWorkloadBalancing workloadBalancingConfig

Class com.mypurecloud.sdk.v2.model.PatchSegment

class PatchSegment extends Object implements Serializable

Serialized Fields

assignmentExpirationDays

Integer assignmentExpirationDays

color

String color

context

Context context

createdDate

Date createdDate

description

String description

displayName

String displayName

externalSegment

PatchExternalSegment externalSegment

id

String id

isActive

Boolean isActive

journey

Journey journey

modifiedDate

Date modifiedDate

selfUri

String selfUri

shouldDisplayToAgent

Boolean shouldDisplayToAgent

version

Integer version

Class com.mypurecloud.sdk.v2.model.PatchShiftTradeRequest

class PatchShiftTradeRequest extends Object implements Serializable

Serialized Fields

acceptableIntervals

ListWrapperInterval acceptableIntervals

expiration

ValueWrapperDate expiration

metadata

WfmVersionedEntityMetadata metadata

receivingUserId

ValueWrapperString receivingUserId

Class com.mypurecloud.sdk.v2.model.PatchSurveyQuestion

class PatchSurveyQuestion extends Object implements Serializable

Serialized Fields

choices

List<String> choices

customerProperty

PatchSurveyQuestion.CustomerPropertyEnum customerProperty

isMandatory

Boolean isMandatory

label

String label

type

PatchSurveyQuestion.TypeEnum type

Class com.mypurecloud.sdk.v2.model.PatchTextStyleProperties

class PatchTextStyleProperties extends Object implements Serializable

Serialized Fields

color

String color

font

String font

fontSize

String fontSize

textAlign

PatchTextStyleProperties.TextAlignEnum textAlign

Class com.mypurecloud.sdk.v2.model.PatchUser

class PatchUser extends Object implements Serializable

Serialized Fields

acdAutoAnswer

Boolean acdAutoAnswer

id

String id

Class com.mypurecloud.sdk.v2.model.PatchWebMessagingOfferFields

class PatchWebMessagingOfferFields extends Object implements Serializable

Serialized Fields

architectFlow

AddressableEntityRef architectFlow

offerText

String offerText

Class com.mypurecloud.sdk.v2.model.PerformanceProfile

class PerformanceProfile extends Object implements Serializable

Serialized Fields

active

Boolean active

dateCreated

Date dateCreated

description

String description

division

Division division

id

String id

maxLeaderboardRankSize

Integer maxLeaderboardRankSize

memberCount

Integer memberCount

metricOrders

List<String> metricOrders

name

String name

reportingIntervals

List<ReportingInterval> reportingIntervals

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.PermissionCollectionEntityListing

class PermissionCollectionEntityListing extends Object implements Serializable

Serialized Fields

entities

List<DomainPermissionCollection> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.PermissionDetails

class PermissionDetails extends Object implements Serializable

Serialized Fields

allowsCurrentUser

Boolean allowsCurrentUser

enforced

Boolean enforced

permissions

List<String> permissions

type

PermissionDetails.TypeEnum type

Class com.mypurecloud.sdk.v2.model.Permissions

class Permissions extends Object implements Serializable

Serialized Fields

ids

List<String> ids

Class com.mypurecloud.sdk.v2.model.Phone

class Phone extends Object implements Serializable

Serialized Fields

capabilities

PhoneCapabilities capabilities

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

id

String id

lineBaseSettings

DomainEntityRef lineBaseSettings

lines

List<Line> lines

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

phoneBaseSettings

PhoneBaseSettings phoneBaseSettings

phoneMetaBase

DomainEntityRef phoneMetaBase

primaryEdge

Edge primaryEdge

properties

Map<String,Object> properties

secondaryEdge

Edge secondaryEdge

secondaryStatus

PhoneStatus secondaryStatus

selfUri

String selfUri

site

DomainEntityRef site

state

Phone.StateEnum state

status

PhoneStatus status

userAgentInfo

UserAgentInfo userAgentInfo

version

Integer version

webRtcUser

DomainEntityRef webRtcUser

Class com.mypurecloud.sdk.v2.model.PhoneBase

class PhoneBase extends Object implements Serializable

Serialized Fields

capabilities

PhoneCapabilities capabilities

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

id

String id

lines

List<LineBase> lines

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

phoneMetaBase

DomainEntityRef phoneMetaBase

properties

Map<String,Object> properties

selfUri

String selfUri

state

PhoneBase.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.PhoneBaseEntityListing

class PhoneBaseEntityListing extends Object implements Serializable

Serialized Fields

entities

List<PhoneBase> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.PhoneBaseSettings

class PhoneBaseSettings extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.PhoneCapabilities

class PhoneCapabilities extends Object implements Serializable

Serialized Fields

allowReboot

Boolean allowReboot

cdm

Boolean cdm

dualRegisters

Boolean dualRegisters

hardwareIdType

String hardwareIdType

mediaCodecs

List<PhoneCapabilities.MediaCodecsEnum> mediaCodecs

noCloudProvisioning

Boolean noCloudProvisioning

noRebalance

Boolean noRebalance

provisions

Boolean provisions

registers

Boolean registers

Class com.mypurecloud.sdk.v2.model.PhoneChangeTopicEdgeReference

class PhoneChangeTopicEdgeReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.PhoneChangeTopicLineStatus

class PhoneChangeTopicLineStatus extends Object implements Serializable

Serialized Fields

addressOfRecord

String addressOfRecord

contactAddresses

List<String> contactAddresses

id

String id

reachable

Boolean reachable

reachableStateTime

Date reachableStateTime

Class com.mypurecloud.sdk.v2.model.PhoneChangeTopicPhone

class PhoneChangeTopicPhone extends Object implements Serializable

Serialized Fields

id

String id

secondaryStatus

PhoneChangeTopicPhoneStatus secondaryStatus

status

PhoneChangeTopicPhoneStatus status

userAgentInfo

PhoneChangeTopicUserAgentInfo userAgentInfo

Class com.mypurecloud.sdk.v2.model.PhoneChangeTopicPhoneStatus

class PhoneChangeTopicPhoneStatus extends Object implements Serializable

Serialized Fields

edge

PhoneChangeTopicEdgeReference edge

eventCreationTime

Date eventCreationTime

id

String id

lineStatuses

List<PhoneChangeTopicLineStatus> lineStatuses

operationalStatus

PhoneChangeTopicPhoneStatus.OperationalStatusEnum operationalStatus

provision

PhoneChangeTopicProvisionInfo provision

Class com.mypurecloud.sdk.v2.model.PhoneChangeTopicProvisionInfo

class PhoneChangeTopicProvisionInfo extends Object implements Serializable

Serialized Fields

errorInfo

String errorInfo

source

String source

time

Date time

Class com.mypurecloud.sdk.v2.model.PhoneChangeTopicUserAgentInfo

class PhoneChangeTopicUserAgentInfo extends Object implements Serializable

Serialized Fields

firmwareVersion

String firmwareVersion

manufacturer

String manufacturer

model

String model

Class com.mypurecloud.sdk.v2.model.PhoneColumn

class PhoneColumn extends Object implements Serializable

Serialized Fields

columnName

String columnName

type

String type

Class com.mypurecloud.sdk.v2.model.PhoneEntityListing

class PhoneEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Phone> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.PhoneEstablishedEvent

class PhoneEstablishedEvent extends Object implements Serializable

Serialized Fields

ani

String ani

communicationId

String communicationId

conversationId

String conversationId

dnis

String dnis

eventDateTime

Date eventDateTime

eventId

String eventId

initialConfiguration

InitialConfiguration initialConfiguration

phoneNumber

String phoneNumber

sourceConfiguration

SourceConfiguration sourceConfiguration

Class com.mypurecloud.sdk.v2.model.PhoneMetaBaseEntityListing

class PhoneMetaBaseEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Metabase> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.PhoneNumber

class PhoneNumber extends Object implements Serializable

Serialized Fields

acceptsSMS

Boolean acceptsSMS

countryCode

String countryCode

display

String display

e164

String e164

extension

Long extension

userInput

String userInput

Class com.mypurecloud.sdk.v2.model.PhoneNumberColumn

class PhoneNumberColumn extends Object implements Serializable

Serialized Fields

columnName

String columnName

type

String type

Class com.mypurecloud.sdk.v2.model.PhoneNumberStatus

class PhoneNumberStatus extends Object implements Serializable

Serialized Fields

callable

Boolean callable

Class com.mypurecloud.sdk.v2.model.PhonesReboot

class PhonesReboot extends Object implements Serializable

Serialized Fields

phoneIds

List<String> phoneIds

siteId

String siteId

Class com.mypurecloud.sdk.v2.model.PhoneStatus

class PhoneStatus extends Object implements Serializable

Serialized Fields

edge

DomainEntityRef edge

edgesStatus

PhoneStatus.EdgesStatusEnum edgesStatus

eventCreationTime

String eventCreationTime

id

String id

lineStatuses

List<LineStatus> lineStatuses

name

String name

operationalStatus

PhoneStatus.OperationalStatusEnum operationalStatus

phoneAssignmentToEdgeType

PhoneStatus.PhoneAssignmentToEdgeTypeEnum phoneAssignmentToEdgeType

provision

ProvisionInfo provision

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.PhoneTransferEvent

class PhoneTransferEvent extends Object implements Serializable

Serialized Fields

commandId

String commandId

conversationId

String conversationId

destinationPhoneNumber

String destinationPhoneNumber

eventDateTime

Date eventDateTime

eventId

String eventId

initiatingCommunicationId

String initiatingCommunicationId

objectCommunicationId

String objectCommunicationId

targetCommunicationId

String targetCommunicationId

transferType

PhoneTransferEvent.TransferTypeEnum transferType

Class com.mypurecloud.sdk.v2.model.Phrase

class Phrase extends Object implements Serializable

Serialized Fields

sentiment

Phrase.SentimentEnum sentiment

strictness

Phrase.StrictnessEnum strictness

text

String text

Class com.mypurecloud.sdk.v2.model.PhraseAssociations

class PhraseAssociations extends Object implements Serializable

Serialized Fields

documentId

String documentId

phraseId

String phraseId

Class com.mypurecloud.sdk.v2.model.PhysicalInterfaceEntityListing

class PhysicalInterfaceEntityListing extends Object implements Serializable

Serialized Fields

entities

List<DomainPhysicalInterface> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.PINConfiguration

class PINConfiguration extends Object implements Serializable

Serialized Fields

maximumLength

Integer maximumLength

minimumLength

Integer minimumLength

Class com.mypurecloud.sdk.v2.model.PingIdentity

class PingIdentity extends Object implements Serializable

Serialized Fields

certificate

String certificate

certificates

List<String> certificates

disabled

Boolean disabled

id

String id

issuerURI

String issuerURI

name

String name

relyingPartyIdentifier

String relyingPartyIdentifier

selfUri

String selfUri

sloBinding

String sloBinding

sloURI

String sloURI

ssoTargetURI

String ssoTargetURI

Class com.mypurecloud.sdk.v2.model.PlanningGroup

class PlanningGroup extends Object implements Serializable

Serialized Fields

id

String id

metadata

WfmVersionedEntityMetadata metadata

name

String name

routePaths

List<RoutePathResponse> routePaths

selfUri

String selfUri

serviceGoalTemplate

ServiceGoalTemplateReference serviceGoalTemplate

Class com.mypurecloud.sdk.v2.model.PlanningGroupList

class PlanningGroupList extends Object implements Serializable

Serialized Fields

entities

List<PlanningGroup> entities

Class com.mypurecloud.sdk.v2.model.PlanningGroupReference

class PlanningGroupReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.PlanningPeriodSettings

class PlanningPeriodSettings extends Object implements Serializable

Serialized Fields

startDate

LocalDate startDate

weekCount

Integer weekCount

Class com.mypurecloud.sdk.v2.model.Policy

class Policy extends Object implements Serializable

Serialized Fields

actions

PolicyActions actions

conditions

PolicyConditions conditions

createdDate

Date createdDate

description

String description

enabled

Boolean enabled

id

String id

mediaPolicies

MediaPolicies mediaPolicies

modifiedDate

Date modifiedDate

name

String name

order

Integer order

policyErrors

PolicyErrors policyErrors

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.PolicyActions

class PolicyActions extends Object implements Serializable

Serialized Fields

alwaysDelete

Boolean alwaysDelete

assignCalibrations

List<CalibrationAssignment> assignCalibrations

assignEvaluations

List<EvaluationAssignment> assignEvaluations

assignMeteredAssignmentByAgent

List<MeteredAssignmentByAgent> assignMeteredAssignmentByAgent

assignMeteredEvaluations

List<MeteredEvaluationAssignment> assignMeteredEvaluations

assignSurveys

List<SurveyAssignment> assignSurveys

deleteRecording

Boolean deleteRecording

initiateScreenRecording

InitiateScreenRecording initiateScreenRecording

integrationExport

IntegrationExport integrationExport

mediaTranscriptions

List<MediaTranscription> mediaTranscriptions

retainRecording

Boolean retainRecording

retentionDuration

RetentionDuration retentionDuration

Class com.mypurecloud.sdk.v2.model.PolicyConditions

class PolicyConditions extends Object implements Serializable

Serialized Fields

customerParticipation

PolicyConditions.CustomerParticipationEnum customerParticipation

dateRanges

List<String> dateRanges

directions

List<PolicyConditions.DirectionsEnum> directions

duration

DurationCondition duration

forQueues

List<Queue> forQueues

forUsers

List<User> forUsers

mediaTypes

List<PolicyConditions.MediaTypesEnum> mediaTypes

timeAllowed

TimeAllowed timeAllowed

wrapupCodes

List<WrapupCode> wrapupCodes

Class com.mypurecloud.sdk.v2.model.PolicyCreate

class PolicyCreate extends Object implements Serializable

Serialized Fields

actions

PolicyActions actions

conditions

PolicyConditions conditions

createdDate

Date createdDate

description

String description

enabled

Boolean enabled

id

String id

mediaPolicies

MediaPolicies mediaPolicies

modifiedDate

Date modifiedDate

name

String name

order

Integer order

policyErrors

PolicyErrors policyErrors

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.PolicyEntityListing

class PolicyEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Policy> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.PolicyErrorMessage

class PolicyErrorMessage extends Object implements Serializable

Serialized Fields

correlationId

String correlationId

errorCode

String errorCode

insertDate

Date insertDate

statusCode

Integer statusCode

userMessage

Object userMessage

userParams

List<UserParam> userParams

userParamsMessage

String userParamsMessage

Class com.mypurecloud.sdk.v2.model.PolicyErrors

class PolicyErrors extends Object implements Serializable

Serialized Fields

policyErrorMessages

List<PolicyErrorMessage> policyErrorMessages

Class com.mypurecloud.sdk.v2.model.PolicyUpdate

class PolicyUpdate extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

Class com.mypurecloud.sdk.v2.model.PositionSettings

class PositionSettings extends Object implements Serializable

Serialized Fields

alignment

PositionSettings.AlignmentEnum alignment

bottomSpace

Integer bottomSpace

sideSpace

Integer sideSpace

Class com.mypurecloud.sdk.v2.model.PossibleWorkShiftsForWeek

class PossibleWorkShiftsForWeek extends Object implements Serializable

Serialized Fields

dailyPossibleShifts

List<DailyPossibleShift> dailyPossibleShifts

id

Integer id

Class com.mypurecloud.sdk.v2.model.PostActionInput

class PostActionInput extends Object implements Serializable

Serialized Fields

category

String category

config

ActionConfig config

contract

ActionContractInput contract

integrationId

String integrationId

name

String name

secure

Boolean secure

Class com.mypurecloud.sdk.v2.model.PostInputContract

class PostInputContract extends Object implements Serializable

Serialized Fields

inputSchema

JsonSchemaDocument inputSchema

Class com.mypurecloud.sdk.v2.model.PostOutputContract

class PostOutputContract extends Object implements Serializable

Serialized Fields

successSchema

JsonSchemaDocument successSchema

Class com.mypurecloud.sdk.v2.model.PostTextMessage

class PostTextMessage extends Object implements Serializable

Serialized Fields

content

List<ConversationMessageContent> content

text

String text

type

PostTextMessage.TypeEnum type

Class com.mypurecloud.sdk.v2.model.PostTextRequest

class PostTextRequest extends Object implements Serializable

Serialized Fields

amazonLexRequest

AmazonLexRequest amazonLexRequest

botAlias

String botAlias

botChannels

List<PostTextRequest.BotChannelsEnum> botChannels

botCorrelationId

String botCorrelationId

botId

String botId

botSessionId

String botSessionId

botSessionTimeoutMinutes

Integer botSessionTimeoutMinutes

genesysBotConnector

GenesysBotConnector genesysBotConnector

googleDialogflow

GoogleDialogflowCustomSettings googleDialogflow

integrationId

String integrationId

languageCode

String languageCode

messagingPlatformType

PostTextRequest.MessagingPlatformTypeEnum messagingPlatformType

nuanceMixDlg

NuanceMixDlgSettings nuanceMixDlg

postTextMessage

PostTextMessage postTextMessage

Class com.mypurecloud.sdk.v2.model.PostTextResponse

class PostTextResponse extends Object implements Serializable

Serialized Fields

amazonLex

Map<String,Object> amazonLex

botCorrelationId

String botCorrelationId

botState

PostTextResponse.BotStateEnum botState

genesysBotConnector

Map<String,Object> genesysBotConnector

genesysDialogEngine

Map<String,Object> genesysDialogEngine

googleDialogFlow

Map<String,Object> googleDialogFlow

intentName

String intentName

nuanceMixDlg

Map<String,Object> nuanceMixDlg

replyMessages

List<PostTextMessage> replyMessages

slots

Map<String,String> slots

Class com.mypurecloud.sdk.v2.model.PredictionResults

class PredictionResults extends Object implements Serializable

Serialized Fields

estimatedWaitTimeSeconds

Integer estimatedWaitTimeSeconds

formula

PredictionResults.FormulaEnum formula

intent

PredictionResults.IntentEnum intent

Class com.mypurecloud.sdk.v2.model.PredictiveRouting

class PredictiveRouting extends Object implements Serializable

Serialized Fields

enableConversationScoreBiasing

Boolean enableConversationScoreBiasing

respectSkills

Boolean respectSkills

Class com.mypurecloud.sdk.v2.model.Predictor

class Predictor extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

errorCode

String errorCode

id

String id

kpi

String kpi

models

List<PredictorModelBrief> models

queues

List<AddressableEntityRef> queues

routingTimeoutSeconds

Integer routingTimeoutSeconds

schedule

PredictorSchedule schedule

selfUri

String selfUri

state

Predictor.StateEnum state

workloadBalancingConfig

PredictorWorkloadBalancing workloadBalancingConfig

Class com.mypurecloud.sdk.v2.model.PredictorListing

class PredictorListing extends Object implements Serializable

Serialized Fields

entities

List<Predictor> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.PredictorModel

class PredictorModel extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateTrained

Date dateTrained

features

List<PredictorModelFeature> features

id

String id

kpi

String kpi

mediaType

PredictorModel.MediaTypeEnum mediaType

queues

List<AddressableEntityRef> queues

Class com.mypurecloud.sdk.v2.model.PredictorModelBrief

class PredictorModelBrief extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

mediaType

PredictorModelBrief.MediaTypeEnum mediaType

retrainingErrors

List<PredictorModelRetrainingError> retrainingErrors

state

PredictorModelBrief.StateEnum state

Class com.mypurecloud.sdk.v2.model.PredictorModelFeature

class PredictorModelFeature extends Object implements Serializable

Serialized Fields

id

String id

percentageImportance

Double percentageImportance

type

PredictorModelFeature.TypeEnum type

Class com.mypurecloud.sdk.v2.model.PredictorModelFeatureListing

class PredictorModelFeatureListing extends Object implements Serializable

Serialized Fields

entities

List<PredictorModelFeature> entities

Class com.mypurecloud.sdk.v2.model.PredictorModelRetrainingError

class PredictorModelRetrainingError extends Object implements Serializable

Serialized Fields

dateOfFirstOccurrence

Date dateOfFirstOccurrence

errorCode

PredictorModelRetrainingError.ErrorCodeEnum errorCode

id

String id

Class com.mypurecloud.sdk.v2.model.PredictorModels

class PredictorModels extends Object implements Serializable

Serialized Fields

entities

List<PredictorModel> entities

predictorModels

List<PredictorModel> predictorModels

Class com.mypurecloud.sdk.v2.model.PredictorSchedule

class PredictorSchedule extends Object implements Serializable

Serialized Fields

dateStarted

Date dateStarted

scheduleType

PredictorSchedule.ScheduleTypeEnum scheduleType

Class com.mypurecloud.sdk.v2.model.PredictorWorkloadBalancing

class PredictorWorkloadBalancing extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

maximumOccupancy

Integer maximumOccupancy

minimumOccupancy

Integer minimumOccupancy

Class com.mypurecloud.sdk.v2.model.PresenceDefinition

class PresenceDefinition extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

systemPresence

String systemPresence

Class com.mypurecloud.sdk.v2.model.PresenceDetailQueryClause

class PresenceDetailQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<PresenceDetailQueryPredicate> predicates

type

PresenceDetailQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.PresenceDetailQueryFilter

class PresenceDetailQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<PresenceDetailQueryClause> clauses

predicates

List<PresenceDetailQueryPredicate> predicates

type

PresenceDetailQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.PresenceDetailQueryPredicate

class PresenceDetailQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

PresenceDetailQueryPredicate.DimensionEnum dimension

operator

PresenceDetailQueryPredicate.OperatorEnum operator

range

NumericRange range

type

PresenceDetailQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.PresenceEventOrganizationPresence

class PresenceEventOrganizationPresence extends Object implements Serializable

Serialized Fields

id

String id

systemPresence

String systemPresence

Class com.mypurecloud.sdk.v2.model.PresenceEventUserPresence

class PresenceEventUserPresence extends Object implements Serializable

Serialized Fields

message

String message

modifiedDate

Date modifiedDate

presenceDefinition

PresenceEventOrganizationPresence presenceDefinition

primary

Boolean primary

source

String source

Class com.mypurecloud.sdk.v2.model.PresenceSettings

class PresenceSettings extends Object implements Serializable

Serialized Fields

id

String id

name

String name

restorePresenceSettings

RestorePresenceSettings restorePresenceSettings

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ProcessScheduleUpdateUploadRequest

class ProcessScheduleUpdateUploadRequest extends Object implements Serializable

Serialized Fields

managementUnitIdsForAddedTeamUsers

List<String> managementUnitIdsForAddedTeamUsers

teamIds

List<String> teamIds

uploadKey

String uploadKey

Class com.mypurecloud.sdk.v2.model.ProfileWithDateRange

class ProfileWithDateRange extends Object implements Serializable

Serialized Fields

dateEndWorkday

LocalDate dateEndWorkday

dateStartWorkday

LocalDate dateStartWorkday

division

Division division

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.Program

class Program extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

datePublished

Date datePublished

description

String description

id

String id

modifiedBy

AddressableEntityRef modifiedBy

name

String name

published

Boolean published

publishedBy

AddressableEntityRef publishedBy

selfUri

String selfUri

tags

List<String> tags

topics

List<BaseTopicEntitiy> topics

Class com.mypurecloud.sdk.v2.model.ProgramJob

class ProgramJob extends Object implements Serializable

Serialized Fields

createdBy

AddressableEntityRef createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

programs

List<BaseProgramEntity> programs

selfUri

String selfUri

state

ProgramJob.StateEnum state

Class com.mypurecloud.sdk.v2.model.ProgramJobRequest

class ProgramJobRequest extends Object implements Serializable

Serialized Fields

programIds

List<String> programIds

Class com.mypurecloud.sdk.v2.model.ProgramMappings

class ProgramMappings extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

flows

List<AddressableEntityRef> flows

modifiedBy

AddressableEntityRef modifiedBy

program

BaseProgramEntity program

queues

List<AddressableEntityRef> queues

Class com.mypurecloud.sdk.v2.model.ProgramMappingsRequest

class ProgramMappingsRequest extends Object implements Serializable

Serialized Fields

flowIds

List<String> flowIds

queueIds

List<String> queueIds

Class com.mypurecloud.sdk.v2.model.ProgramRequest

class ProgramRequest extends Object implements Serializable

Serialized Fields

description

String description

name

String name

tags

List<String> tags

topicIds

List<String> topicIds

Class com.mypurecloud.sdk.v2.model.ProgramsEntityListing

class ProgramsEntityListing extends Object implements Serializable

Serialized Fields

entities

List<ListedProgram> entities

nextUri

String nextUri

pageCount

Integer pageCount

pageSize

Integer pageSize

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ProgramsMappingsEntityListing

class ProgramsMappingsEntityListing extends Object implements Serializable

Serialized Fields

entities

List<ProgramMappings> entities

nextUri

String nextUri

pageCount

Integer pageCount

pageSize

Integer pageSize

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ProgramTranscriptionEngines

class ProgramTranscriptionEngines extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

modifiedBy

AddressableEntityRef modifiedBy

program

BaseProgramEntity program

transcriptionEngines

List<TranscriptionEngines> transcriptionEngines

Class com.mypurecloud.sdk.v2.model.ProgressConsultTransferEvent

class ProgressConsultTransferEvent extends Object implements Serializable

Serialized Fields

conversationId

String conversationId

destinationCommunicationId

String destinationCommunicationId

eventDateTime

Date eventDateTime

eventId

String eventId

initiatingCommunicationId

String initiatingCommunicationId

objectCommunicationId

String objectCommunicationId

Class com.mypurecloud.sdk.v2.model.ProgressTransferEvent

class ProgressTransferEvent extends Object implements Serializable

Serialized Fields

commandId

String commandId

conversationId

String conversationId

destinationCommunicationId

String destinationCommunicationId

eventDateTime

Date eventDateTime

eventId

String eventId

objectCommunicationId

String objectCommunicationId

Class com.mypurecloud.sdk.v2.model.Prompt

class Prompt extends Object implements Serializable

Serialized Fields

currentOperation

Operation currentOperation

description

String description

id

String id

name

String name

resources

List<PromptAsset> resources

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.PromptAsset

class PromptAsset extends Object implements Serializable

Serialized Fields

durationSeconds

Double durationSeconds

id

String id

language

String language

languageDefault

Boolean languageDefault

mediaUri

String mediaUri

name

String name

promptId

String promptId

selfUri

String selfUri

tags

Map<String,List<String>> tags

text

String text

ttsString

String ttsString

uploadStatus

PromptAsset.UploadStatusEnum uploadStatus

uploadUri

String uploadUri

Class com.mypurecloud.sdk.v2.model.PromptAssetCreate

class PromptAssetCreate extends Object implements Serializable

Serialized Fields

durationSeconds

Double durationSeconds

id

String id

language

String language

languageDefault

Boolean languageDefault

mediaUri

String mediaUri

name

String name

promptId

String promptId

selfUri

String selfUri

tags

Map<String,List<String>> tags

text

String text

ttsString

String ttsString

uploadStatus

PromptAssetCreate.UploadStatusEnum uploadStatus

uploadUri

String uploadUri

Class com.mypurecloud.sdk.v2.model.PromptAssetEntityListing

class PromptAssetEntityListing extends Object implements Serializable

Serialized Fields

entities

List<PromptAsset> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.PromptEntityListing

class PromptEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Prompt> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.PropertyChange

class PropertyChange extends Object implements Serializable

Serialized Fields

newValues

List<String> newValues

oldValues

List<String> oldValues

property

String property

Class com.mypurecloud.sdk.v2.model.PropertyIndexRequest

class PropertyIndexRequest extends Object implements Serializable

Serialized Fields

properties

List<AnalyticsProperty> properties

sessionId

String sessionId

targetDate

Date targetDate

Class com.mypurecloud.sdk.v2.model.ProvisionInfo

class ProvisionInfo extends Object implements Serializable

Serialized Fields

errorInfo

String errorInfo

source

String source

time

Date time

Class com.mypurecloud.sdk.v2.model.PublishDraftInput

class PublishDraftInput extends Object implements Serializable

Serialized Fields

version

Integer version

Class com.mypurecloud.sdk.v2.model.PublishedSurveyFormReference

class PublishedSurveyFormReference extends Object implements Serializable

Serialized Fields

contextId

String contextId

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.PublishForm

class PublishForm extends Object implements Serializable

Serialized Fields

id

String id

published

Boolean published

Class com.mypurecloud.sdk.v2.model.PublishProgramTopicsDefinitionsJob

class PublishProgramTopicsDefinitionsJob extends Object implements Serializable

Serialized Fields

id

String id

state

PublishProgramTopicsDefinitionsJob.StateEnum state

Class com.mypurecloud.sdk.v2.model.PublishTopicTopicsDefinitionsJob

class PublishTopicTopicsDefinitionsJob extends Object implements Serializable

Serialized Fields

id

String id

state

PublishTopicTopicsDefinitionsJob.StateEnum state

Class com.mypurecloud.sdk.v2.model.PunctualityEvent

class PunctualityEvent extends Object implements Serializable

Serialized Fields

activityCode

String activityCode

activityCodeId

String activityCodeId

activityName

String activityName

bullseye

Boolean bullseye

category

String category

dateScheduleStart

Date dateScheduleStart

dateStart

Date dateStart

delta

Double delta

description

String description

lengthMinutes

Integer lengthMinutes

points

Integer points

Class com.mypurecloud.sdk.v2.model.PureCloud

class PureCloud extends Object implements Serializable

Serialized Fields

disabled

Boolean disabled

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.PureEngage

class PureEngage extends Object implements Serializable

Serialized Fields

autoProvisionUsers

Boolean autoProvisionUsers

certificate

String certificate

certificates

List<String> certificates

disabled

Boolean disabled

id

String id

issuerURI

String issuerURI

name

String name

relyingPartyIdentifier

String relyingPartyIdentifier

selfUri

String selfUri

sloBinding

String sloBinding

sloURI

String sloURI

ssoTargetURI

String ssoTargetURI

Class com.mypurecloud.sdk.v2.model.QMAuditQueryRequest

class QMAuditQueryRequest extends Object implements Serializable

Serialized Fields

filters

List<QualityAuditQueryFilter> filters

interval

String interval

sort

List<AuditQuerySort> sort

Class com.mypurecloud.sdk.v2.model.QualityAuditLogMessage

class QualityAuditLogMessage extends Object implements Serializable

Serialized Fields

action

QualityAuditLogMessage.ActionEnum action

client

AddressableEntityRef client

context

Map<String,String> context

entity

DomainEntityRef entity

entityType

QualityAuditLogMessage.EntityTypeEnum entityType

eventDate

Date eventDate

id

String id

level

QualityAuditLogMessage.LevelEnum level

messageInfo

MessageInfo messageInfo

propertyChanges

List<PropertyChange> propertyChanges

remoteIps

List<String> remoteIps

serviceName

QualityAuditLogMessage.ServiceNameEnum serviceName

status

QualityAuditLogMessage.StatusEnum status

user

DomainEntityRef user

userHomeOrgId

String userHomeOrgId

userTrusteeOrgId

String userTrusteeOrgId

Class com.mypurecloud.sdk.v2.model.QualityAuditQueryExecutionResultsResponse

class QualityAuditQueryExecutionResultsResponse extends Object implements Serializable

Serialized Fields

cursor

String cursor

entities

List<QualityAuditLogMessage> entities

id

String id

pageSize

Integer pageSize

Class com.mypurecloud.sdk.v2.model.QualityAuditQueryExecutionStatusResponse

class QualityAuditQueryExecutionStatusResponse extends Object implements Serializable

Serialized Fields

dateStart

Date dateStart

filters

List<QualityAuditQueryFilter> filters

id

String id

interval

String interval

sort

List<AuditQuerySort> sort

state

QualityAuditQueryExecutionStatusResponse.StateEnum state

Class com.mypurecloud.sdk.v2.model.QualityAuditQueryFilter

class QualityAuditQueryFilter extends Object implements Serializable

Serialized Fields

property

QualityAuditQueryFilter.PropertyEnum property

value

String value

Class com.mypurecloud.sdk.v2.model.QualityEvaluationScoreItem

class QualityEvaluationScoreItem extends Object implements Serializable

Serialized Fields

conversationDate

Date conversationDate

conversationEndDate

Date conversationEndDate

conversationId

String conversationId

evaluationId

String evaluationId

evaluationScore

Double evaluationScore

formName

String formName

maxPoints

Integer maxPoints

mediaTypes

List<QualityEvaluationScoreItem.MediaTypesEnum> mediaTypes

points

Integer points

Class com.mypurecloud.sdk.v2.model.QueryAdherenceExplanationsResponse

class QueryAdherenceExplanationsResponse extends Object implements Serializable

Serialized Fields

downloadUrl

String downloadUrl

job

AdherenceExplanationJobReference job

result

AdherenceExplanationListing result

Class com.mypurecloud.sdk.v2.model.QueryCriteria

class QueryCriteria extends Object implements Serializable

Serialized Fields

categoryInfo

CriteriaCategoryInfo categoryInfo

criteriaGroups

List<QueryCriteria.CriteriaGroupsEnum> criteriaGroups

criteriaKey

QueryCriteria.CriteriaKeyEnum criteriaKey

dataType

QueryCriteria.DataTypeEnum dataType

description

String description

operators

List<String> operators

Class com.mypurecloud.sdk.v2.model.QueryDivision

class QueryDivision extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.QueryFacetInfo

class QueryFacetInfo extends Object implements Serializable

Serialized Fields

attributes

List<FacetKeyAttribute> attributes

facets

List<FacetEntry> facets

Class com.mypurecloud.sdk.v2.model.QueryRequest

class QueryRequest extends Object implements Serializable

Serialized Fields

attributeFilters

List<AttributeFilterItem> attributeFilters

facetNameRequests

List<String> facetNameRequests

filters

List<ContentFilterItem> filters

includeShares

Boolean includeShares

pageNumber

Integer pageNumber

pageSize

Integer pageSize

queryPhrase

String queryPhrase

sort

List<SortItem> sort

Class com.mypurecloud.sdk.v2.model.QueryRequestClause

class QueryRequestClause extends Object implements Serializable

Serialized Fields

predicates

List<QueryRequestPredicate> predicates

type

QueryRequestClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.QueryRequestFilter

class QueryRequestFilter extends Object implements Serializable

Serialized Fields

clauses

List<QueryRequestClause> clauses

type

QueryRequestFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.QueryRequestPredicate

class QueryRequestPredicate extends Object implements Serializable

Serialized Fields

dimension

QueryRequestPredicate.DimensionEnum dimension

value

String value

Class com.mypurecloud.sdk.v2.model.QueryResponseData

class QueryResponseData extends Object implements Serializable

Serialized Fields

interval

String interval

metrics

List<QueryResponseMetric> metrics

Class com.mypurecloud.sdk.v2.model.QueryResponseGroupedData

class QueryResponseGroupedData extends Object implements Serializable

Serialized Fields

data

List<QueryResponseData> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.QueryResponseMetric

class QueryResponseMetric extends Object implements Serializable

Serialized Fields

metric

QueryResponseMetric.MetricEnum metric

stats

QueryResponseStats stats

Class com.mypurecloud.sdk.v2.model.QueryResponseStats

class QueryResponseStats extends Object implements Serializable

Serialized Fields

count

Integer count

Class com.mypurecloud.sdk.v2.model.QueryResult

class QueryResult extends Object implements Serializable

Serialized Fields

body

DomainEntity body

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.QueryResults

class QueryResults extends Object implements Serializable

Serialized Fields

facetInfo

QueryFacetInfo facetInfo

results

DomainEntityListingQueryResult results

Class com.mypurecloud.sdk.v2.model.QueryTimeOffLimitValuesRequest

class QueryTimeOffLimitValuesRequest extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

dateRanges

List<LocalDateRange> dateRanges

timeOffLimitId

String timeOffLimitId

Class com.mypurecloud.sdk.v2.model.QueryTimeOffLimitValuesResponse

class QueryTimeOffLimitValuesResponse extends Object implements Serializable

Serialized Fields

values

List<TimeOffLimitValueRange> values

Class com.mypurecloud.sdk.v2.model.QueryWaitlistPositionsRequest

class QueryWaitlistPositionsRequest extends Object implements Serializable

Serialized Fields

timeOffRequests

List<UserTimeOffRequestReference> timeOffRequests

Class com.mypurecloud.sdk.v2.model.Queue

class Queue extends Object implements Serializable

Serialized Fields

acwSettings

AcwSettings acwSettings

agentOwnedRouting

AgentOwnedRouting agentOwnedRouting

autoAnswerOnly

Boolean autoAnswerOnly

bullseye

Bullseye bullseye

callingPartyName

String callingPartyName

callingPartyNumber

String callingPartyNumber

createdBy

String createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

defaultScripts

Map<String,Script> defaultScripts

description

String description

directRouting

DirectRouting directRouting

division

Division division

emailInQueueFlow

DomainEntityRef emailInQueueFlow

enableManualAssignment

Boolean enableManualAssignment

enableTranscription

Boolean enableTranscription

id

String id

joinedMemberCount

Integer joinedMemberCount

mediaSettings

QueueMediaSettings mediaSettings

memberCount

Integer memberCount

memberGroups

List<MemberGroup> memberGroups

messageInQueueFlow

DomainEntityRef messageInQueueFlow

modifiedBy

String modifiedBy

name

String name

onHoldPrompt

DomainEntityRef onHoldPrompt

outboundEmailAddress

QueueEmailAddress outboundEmailAddress

outboundMessagingAddresses

QueueMessagingAddresses outboundMessagingAddresses

peerId

String peerId

queueFlow

DomainEntityRef queueFlow

routingRules

List<RoutingRule> routingRules

selfUri

String selfUri

skillEvaluationMethod

Queue.SkillEvaluationMethodEnum skillEvaluationMethod

userMemberCount

Integer userMemberCount

whisperPrompt

DomainEntityRef whisperPrompt

Class com.mypurecloud.sdk.v2.model.QueueConversationCallbackEventTopicCallbackConversation

class QueueConversationCallbackEventTopicCallbackConversation extends Object implements Serializable

Serialized Fields

id

String id

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<QueueConversationCallbackEventTopicCallbackMediaParticipant> participants

Class com.mypurecloud.sdk.v2.model.QueueConversationCallbackEventTopicCallbackMediaParticipant

class QueueConversationCallbackEventTopicCallbackMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

automatedCallbackConfigId

String automatedCallbackConfigId

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Date callbackScheduledTime

callbackUserName

String callbackUserName

connectedTime

Date connectedTime

conversationRoutingData

QueueConversationCallbackEventTopicConversationRoutingData conversationRoutingData

direction

QueueConversationCallbackEventTopicCallbackMediaParticipant.DirectionEnum direction

disconnectType

QueueConversationCallbackEventTopicCallbackMediaParticipant.DisconnectTypeEnum disconnectType

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

QueueConversationCallbackEventTopicErrorBody errorInfo

externalCampaign

Boolean externalCampaign

externalContact

QueueConversationCallbackEventTopicUriReference externalContact

externalOrganization

QueueConversationCallbackEventTopicUriReference externalOrganization

flaggedReason

QueueConversationCallbackEventTopicCallbackMediaParticipant.FlaggedReasonEnum flaggedReason

held

Boolean held

id

String id

initialState

QueueConversationCallbackEventTopicCallbackMediaParticipant.InitialStateEnum initialState

journeyContext

QueueConversationCallbackEventTopicJourneyContext journeyContext

mediaRoles

List<String> mediaRoles

name

String name

outboundPreview

QueueConversationCallbackEventTopicDialerPreview outboundPreview

peer

String peer

provider

String provider

purpose

String purpose

queue

QueueConversationCallbackEventTopicUriReference queue

screenRecordingState

String screenRecordingState

script

QueueConversationCallbackEventTopicUriReference script

skipEnabled

Boolean skipEnabled

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

QueueConversationCallbackEventTopicCallbackMediaParticipant.StateEnum state

team

QueueConversationCallbackEventTopicUriReference team

timeoutSeconds

Integer timeoutSeconds

user

QueueConversationCallbackEventTopicUriReference user

voicemail

QueueConversationCallbackEventTopicVoicemail voicemail

wrapup

QueueConversationCallbackEventTopicWrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.QueueConversationCallbackEventTopicConversationRoutingData

class QueueConversationCallbackEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

QueueConversationCallbackEventTopicUriReference language

priority

Integer priority

queue

QueueConversationCallbackEventTopicUriReference queue

scoredAgents

List<QueueConversationCallbackEventTopicScoredAgent> scoredAgents

skills

List<QueueConversationCallbackEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.QueueConversationCallbackEventTopicDetail

class QueueConversationCallbackEventTopicDetail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.QueueConversationCallbackEventTopicDialerPreview

class QueueConversationCallbackEventTopicDialerPreview extends Object implements Serializable

Serialized Fields

campaignId

String campaignId

contactId

String contactId

contactListId

String contactListId

id

String id

phoneNumberColumns

List<QueueConversationCallbackEventTopicPhoneNumberColumn> phoneNumberColumns

Class com.mypurecloud.sdk.v2.model.QueueConversationCallbackEventTopicErrorBody

class QueueConversationCallbackEventTopicErrorBody extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

details

List<QueueConversationCallbackEventTopicDetail> details

entityId

String entityId

entityName

String entityName

errors

List<QueueConversationCallbackEventTopicErrorBody> errors

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.QueueConversationCallbackEventTopicJourneyAction

class QueueConversationCallbackEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

QueueConversationCallbackEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.QueueConversationCallbackEventTopicJourneyActionMap

class QueueConversationCallbackEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.QueueConversationCallbackEventTopicJourneyContext

class QueueConversationCallbackEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

QueueConversationCallbackEventTopicJourneyCustomer customer

customerSession

QueueConversationCallbackEventTopicJourneyCustomerSession customerSession

triggeringAction

QueueConversationCallbackEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.QueueConversationCallbackEventTopicJourneyCustomer

class QueueConversationCallbackEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.QueueConversationCallbackEventTopicJourneyCustomerSession

class QueueConversationCallbackEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.QueueConversationCallbackEventTopicPhoneNumberColumn

class QueueConversationCallbackEventTopicPhoneNumberColumn extends Object implements Serializable

Serialized Fields

columnName

String columnName

type

String type

Class com.mypurecloud.sdk.v2.model.QueueConversationCallbackEventTopicScoredAgent

class QueueConversationCallbackEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

QueueConversationCallbackEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.QueueConversationCallbackEventTopicUriReference

class QueueConversationCallbackEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.QueueConversationCallbackEventTopicVoicemail

class QueueConversationCallbackEventTopicVoicemail extends Object implements Serializable

Serialized Fields

id

String id

uploadStatus

QueueConversationCallbackEventTopicVoicemail.UploadStatusEnum uploadStatus

Class com.mypurecloud.sdk.v2.model.QueueConversationCallbackEventTopicWrapup

class QueueConversationCallbackEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.QueueConversationCallEventTopicCallConversation

class QueueConversationCallEventTopicCallConversation extends Object implements Serializable

Serialized Fields

id

String id

maxParticipants

Integer maxParticipants

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<QueueConversationCallEventTopicCallMediaParticipant> participants

recordingState

QueueConversationCallEventTopicCallConversation.RecordingStateEnum recordingState

securePause

Boolean securePause

Class com.mypurecloud.sdk.v2.model.QueueConversationCallEventTopicCallMediaParticipant

class QueueConversationCallEventTopicCallMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

ani

String ani

attributes

Map<String,String> attributes

bargedParticipantId

String bargedParticipantId

bargedTime

Date bargedTime

coachedParticipantId

String coachedParticipantId

confined

Boolean confined

connectedTime

Date connectedTime

consultParticipantId

String consultParticipantId

conversationRoutingData

QueueConversationCallEventTopicConversationRoutingData conversationRoutingData

direction

QueueConversationCallEventTopicCallMediaParticipant.DirectionEnum direction

disconnectType

QueueConversationCallEventTopicCallMediaParticipant.DisconnectTypeEnum disconnectType

dnis

String dnis

documentId

String documentId

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

QueueConversationCallEventTopicErrorBody errorInfo

externalContact

QueueConversationCallEventTopicUriReference externalContact

externalOrganization

QueueConversationCallEventTopicUriReference externalOrganization

faxStatus

QueueConversationCallEventTopicFaxStatus faxStatus

flaggedReason

QueueConversationCallEventTopicCallMediaParticipant.FlaggedReasonEnum flaggedReason

group

QueueConversationCallEventTopicUriReference group

held

Boolean held

id

String id

initialState

QueueConversationCallEventTopicCallMediaParticipant.InitialStateEnum initialState

journeyContext

QueueConversationCallEventTopicJourneyContext journeyContext

mediaRoles

List<String> mediaRoles

monitoredParticipantId

String monitoredParticipantId

muted

Boolean muted

name

String name

peer

String peer

provider

String provider

purpose

String purpose

queue

QueueConversationCallEventTopicUriReference queue

recording

Boolean recording

recordingState

QueueConversationCallEventTopicCallMediaParticipant.RecordingStateEnum recordingState

screenRecordingState

String screenRecordingState

script

QueueConversationCallEventTopicUriReference script

securePause

Boolean securePause

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

QueueConversationCallEventTopicCallMediaParticipant.StateEnum state

team

QueueConversationCallEventTopicUriReference team

user

QueueConversationCallEventTopicUriReference user

wrapup

QueueConversationCallEventTopicWrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.QueueConversationCallEventTopicConversationRoutingData

class QueueConversationCallEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

QueueConversationCallEventTopicUriReference language

priority

Integer priority

queue

QueueConversationCallEventTopicUriReference queue

scoredAgents

List<QueueConversationCallEventTopicScoredAgent> scoredAgents

skills

List<QueueConversationCallEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.QueueConversationCallEventTopicDetail

class QueueConversationCallEventTopicDetail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.QueueConversationCallEventTopicErrorBody

class QueueConversationCallEventTopicErrorBody extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

details

List<QueueConversationCallEventTopicDetail> details

entityId

String entityId

entityName

String entityName

errors

List<QueueConversationCallEventTopicErrorBody> errors

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.QueueConversationCallEventTopicFaxStatus

class QueueConversationCallEventTopicFaxStatus extends Object implements Serializable

Serialized Fields

activePage

Integer activePage

bytesTransmitted

Integer bytesTransmitted

dataRate

Integer dataRate

direction

String direction

expectedPages

Integer expectedPages

lineErrors

Integer lineErrors

linesTransmitted

Integer linesTransmitted

pageErrors

Integer pageErrors

Class com.mypurecloud.sdk.v2.model.QueueConversationCallEventTopicJourneyAction

class QueueConversationCallEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

QueueConversationCallEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.QueueConversationCallEventTopicJourneyActionMap

class QueueConversationCallEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.QueueConversationCallEventTopicJourneyContext

class QueueConversationCallEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

QueueConversationCallEventTopicJourneyCustomer customer

customerSession

QueueConversationCallEventTopicJourneyCustomerSession customerSession

triggeringAction

QueueConversationCallEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.QueueConversationCallEventTopicJourneyCustomer

class QueueConversationCallEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.QueueConversationCallEventTopicJourneyCustomerSession

class QueueConversationCallEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.QueueConversationCallEventTopicScoredAgent

class QueueConversationCallEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

QueueConversationCallEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.QueueConversationCallEventTopicUriReference

class QueueConversationCallEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.QueueConversationCallEventTopicWrapup

class QueueConversationCallEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.QueueConversationChatEventTopicChatConversation

class QueueConversationChatEventTopicChatConversation extends Object implements Serializable

Serialized Fields

id

String id

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<QueueConversationChatEventTopicChatMediaParticipant> participants

Class com.mypurecloud.sdk.v2.model.QueueConversationChatEventTopicChatMediaParticipant

class QueueConversationChatEventTopicChatMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

avatarImageUrl

String avatarImageUrl

connectedTime

Date connectedTime

conversationRoutingData

QueueConversationChatEventTopicConversationRoutingData conversationRoutingData

direction

QueueConversationChatEventTopicChatMediaParticipant.DirectionEnum direction

disconnectType

QueueConversationChatEventTopicChatMediaParticipant.DisconnectTypeEnum disconnectType

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

QueueConversationChatEventTopicErrorBody errorInfo

externalContact

QueueConversationChatEventTopicUriReference externalContact

externalOrganization

QueueConversationChatEventTopicUriReference externalOrganization

flaggedReason

QueueConversationChatEventTopicChatMediaParticipant.FlaggedReasonEnum flaggedReason

held

Boolean held

id

String id

initialState

QueueConversationChatEventTopicChatMediaParticipant.InitialStateEnum initialState

journeyContext

QueueConversationChatEventTopicJourneyContext journeyContext

mediaRoles

List<String> mediaRoles

name

String name

peer

String peer

provider

String provider

purpose

String purpose

queue

QueueConversationChatEventTopicUriReference queue

roomId

String roomId

screenRecordingState

String screenRecordingState

script

QueueConversationChatEventTopicUriReference script

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

QueueConversationChatEventTopicChatMediaParticipant.StateEnum state

team

QueueConversationChatEventTopicUriReference team

user

QueueConversationChatEventTopicUriReference user

wrapup

QueueConversationChatEventTopicWrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.QueueConversationChatEventTopicConversationRoutingData

class QueueConversationChatEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

QueueConversationChatEventTopicUriReference language

priority

Integer priority

queue

QueueConversationChatEventTopicUriReference queue

scoredAgents

List<QueueConversationChatEventTopicScoredAgent> scoredAgents

skills

List<QueueConversationChatEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.QueueConversationChatEventTopicDetail

class QueueConversationChatEventTopicDetail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.QueueConversationChatEventTopicErrorBody

class QueueConversationChatEventTopicErrorBody extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

details

List<QueueConversationChatEventTopicDetail> details

entityId

String entityId

entityName

String entityName

errors

List<QueueConversationChatEventTopicErrorBody> errors

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.QueueConversationChatEventTopicJourneyAction

class QueueConversationChatEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

QueueConversationChatEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.QueueConversationChatEventTopicJourneyActionMap

class QueueConversationChatEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.QueueConversationChatEventTopicJourneyContext

class QueueConversationChatEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

QueueConversationChatEventTopicJourneyCustomer customer

customerSession

QueueConversationChatEventTopicJourneyCustomerSession customerSession

triggeringAction

QueueConversationChatEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.QueueConversationChatEventTopicJourneyCustomer

class QueueConversationChatEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.QueueConversationChatEventTopicJourneyCustomerSession

class QueueConversationChatEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.QueueConversationChatEventTopicScoredAgent

class QueueConversationChatEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

QueueConversationChatEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.QueueConversationChatEventTopicUriReference

class QueueConversationChatEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.QueueConversationChatEventTopicWrapup

class QueueConversationChatEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.QueueConversationCobrowseEventTopicCobrowseConversation

class QueueConversationCobrowseEventTopicCobrowseConversation extends Object implements Serializable

Serialized Fields

id

String id

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<QueueConversationCobrowseEventTopicCobrowseMediaParticipant> participants

Class com.mypurecloud.sdk.v2.model.QueueConversationCobrowseEventTopicCobrowseMediaParticipant

class QueueConversationCobrowseEventTopicCobrowseMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

cobrowseRole

String cobrowseRole

cobrowseSessionId

String cobrowseSessionId

connectedTime

Date connectedTime

controlling

List<String> controlling

conversationRoutingData

QueueConversationCobrowseEventTopicConversationRoutingData conversationRoutingData

direction

QueueConversationCobrowseEventTopicCobrowseMediaParticipant.DirectionEnum direction

disconnectType

QueueConversationCobrowseEventTopicCobrowseMediaParticipant.DisconnectTypeEnum disconnectType

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

QueueConversationCobrowseEventTopicErrorBody errorInfo

externalContact

QueueConversationCobrowseEventTopicUriReference externalContact

externalOrganization

QueueConversationCobrowseEventTopicUriReference externalOrganization

flaggedReason

QueueConversationCobrowseEventTopicCobrowseMediaParticipant.FlaggedReasonEnum flaggedReason

held

Boolean held

id

String id

initialState

QueueConversationCobrowseEventTopicCobrowseMediaParticipant.InitialStateEnum initialState

journeyContext

QueueConversationCobrowseEventTopicJourneyContext journeyContext

mediaRoles

List<String> mediaRoles

name

String name

peer

String peer

provider

String provider

providerEventTime

Date providerEventTime

purpose

String purpose

queue

QueueConversationCobrowseEventTopicUriReference queue

screenRecordingState

String screenRecordingState

script

QueueConversationCobrowseEventTopicUriReference script

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

QueueConversationCobrowseEventTopicCobrowseMediaParticipant.StateEnum state

team

QueueConversationCobrowseEventTopicUriReference team

user

QueueConversationCobrowseEventTopicUriReference user

viewerUrl

String viewerUrl

wrapup

QueueConversationCobrowseEventTopicWrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.QueueConversationCobrowseEventTopicConversationRoutingData

class QueueConversationCobrowseEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

QueueConversationCobrowseEventTopicUriReference language

priority

Integer priority

queue

QueueConversationCobrowseEventTopicUriReference queue

scoredAgents

List<QueueConversationCobrowseEventTopicScoredAgent> scoredAgents

skills

List<QueueConversationCobrowseEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.QueueConversationCobrowseEventTopicDetail

class QueueConversationCobrowseEventTopicDetail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.QueueConversationCobrowseEventTopicErrorBody

class QueueConversationCobrowseEventTopicErrorBody extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

details

List<QueueConversationCobrowseEventTopicDetail> details

entityId

String entityId

entityName

String entityName

errors

List<QueueConversationCobrowseEventTopicErrorBody> errors

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.QueueConversationCobrowseEventTopicJourneyAction

class QueueConversationCobrowseEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

QueueConversationCobrowseEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.QueueConversationCobrowseEventTopicJourneyActionMap

class QueueConversationCobrowseEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.QueueConversationCobrowseEventTopicJourneyContext

class QueueConversationCobrowseEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

QueueConversationCobrowseEventTopicJourneyCustomer customer

customerSession

QueueConversationCobrowseEventTopicJourneyCustomerSession customerSession

triggeringAction

QueueConversationCobrowseEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.QueueConversationCobrowseEventTopicJourneyCustomer

class QueueConversationCobrowseEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.QueueConversationCobrowseEventTopicJourneyCustomerSession

class QueueConversationCobrowseEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.QueueConversationCobrowseEventTopicScoredAgent

class QueueConversationCobrowseEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

QueueConversationCobrowseEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.QueueConversationCobrowseEventTopicUriReference

class QueueConversationCobrowseEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.QueueConversationCobrowseEventTopicWrapup

class QueueConversationCobrowseEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.QueueConversationEmailEventTopicAttachment

class QueueConversationEmailEventTopicAttachment extends Object implements Serializable

Serialized Fields

attachmentId

String attachmentId

contentLength

Integer contentLength

contentType

String contentType

contentUri

String contentUri

name

String name

Class com.mypurecloud.sdk.v2.model.QueueConversationEmailEventTopicConversationRoutingData

class QueueConversationEmailEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

QueueConversationEmailEventTopicUriReference language

priority

Integer priority

queue

QueueConversationEmailEventTopicUriReference queue

scoredAgents

List<QueueConversationEmailEventTopicScoredAgent> scoredAgents

skills

List<QueueConversationEmailEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.QueueConversationEmailEventTopicDetail

class QueueConversationEmailEventTopicDetail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.QueueConversationEmailEventTopicEmailConversation

class QueueConversationEmailEventTopicEmailConversation extends Object implements Serializable

Serialized Fields

id

String id

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<QueueConversationEmailEventTopicEmailMediaParticipant> participants

Class com.mypurecloud.sdk.v2.model.QueueConversationEmailEventTopicEmailMediaParticipant

class QueueConversationEmailEventTopicEmailMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

autoGenerated

Boolean autoGenerated

connectedTime

Date connectedTime

conversationRoutingData

QueueConversationEmailEventTopicConversationRoutingData conversationRoutingData

direction

QueueConversationEmailEventTopicEmailMediaParticipant.DirectionEnum direction

disconnectType

QueueConversationEmailEventTopicEmailMediaParticipant.DisconnectTypeEnum disconnectType

draftAttachments

List<QueueConversationEmailEventTopicAttachment> draftAttachments

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

QueueConversationEmailEventTopicErrorBody errorInfo

externalContact

QueueConversationEmailEventTopicUriReference externalContact

externalOrganization

QueueConversationEmailEventTopicUriReference externalOrganization

flaggedReason

QueueConversationEmailEventTopicEmailMediaParticipant.FlaggedReasonEnum flaggedReason

held

Boolean held

id

String id

initialState

QueueConversationEmailEventTopicEmailMediaParticipant.InitialStateEnum initialState

journeyContext

QueueConversationEmailEventTopicJourneyContext journeyContext

mediaRoles

List<String> mediaRoles

messageId

String messageId

messagesSent

Integer messagesSent

name

String name

peer

String peer

provider

String provider

purpose

String purpose

queue

QueueConversationEmailEventTopicUriReference queue

screenRecordingState

String screenRecordingState

script

QueueConversationEmailEventTopicUriReference script

spam

Boolean spam

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

QueueConversationEmailEventTopicEmailMediaParticipant.StateEnum state

subject

String subject

team

QueueConversationEmailEventTopicUriReference team

user

QueueConversationEmailEventTopicUriReference user

wrapup

QueueConversationEmailEventTopicWrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.QueueConversationEmailEventTopicErrorBody

class QueueConversationEmailEventTopicErrorBody extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

details

List<QueueConversationEmailEventTopicDetail> details

entityId

String entityId

entityName

String entityName

errors

List<QueueConversationEmailEventTopicErrorBody> errors

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.QueueConversationEmailEventTopicJourneyAction

class QueueConversationEmailEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

QueueConversationEmailEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.QueueConversationEmailEventTopicJourneyActionMap

class QueueConversationEmailEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.QueueConversationEmailEventTopicJourneyContext

class QueueConversationEmailEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

QueueConversationEmailEventTopicJourneyCustomer customer

customerSession

QueueConversationEmailEventTopicJourneyCustomerSession customerSession

triggeringAction

QueueConversationEmailEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.QueueConversationEmailEventTopicJourneyCustomer

class QueueConversationEmailEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.QueueConversationEmailEventTopicJourneyCustomerSession

class QueueConversationEmailEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.QueueConversationEmailEventTopicScoredAgent

class QueueConversationEmailEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

QueueConversationEmailEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.QueueConversationEmailEventTopicUriReference

class QueueConversationEmailEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.QueueConversationEmailEventTopicWrapup

class QueueConversationEmailEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicAddress

class QueueConversationEventTopicAddress extends Object implements Serializable

Serialized Fields

addressDisplayable

String addressDisplayable

addressNormalized

String addressNormalized

addressRaw

String addressRaw

name

String name

nameRaw

String nameRaw

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicAfterCallWork

class QueueConversationEventTopicAfterCallWork extends Object implements Serializable

Serialized Fields

endTime

Date endTime

startTime

Date startTime

state

QueueConversationEventTopicAfterCallWork.StateEnum state

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicAttachment

class QueueConversationEventTopicAttachment extends Object implements Serializable

Serialized Fields

attachmentId

String attachmentId

contentLength

Integer contentLength

contentType

String contentType

contentUri

String contentUri

name

String name

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicCall

class QueueConversationEventTopicCall extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

agentAssistantId

String agentAssistantId

bargedTime

Date bargedTime

confined

Boolean confined

connectedTime

Date connectedTime

direction

QueueConversationEventTopicCall.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectReasons

List<QueueConversationEventTopicDisconnectReason> disconnectReasons

disconnectType

QueueConversationEventTopicCall.DisconnectTypeEnum disconnectType

documentId

String documentId

errorInfo

QueueConversationEventTopicErrorDetails errorInfo

faxStatus

QueueConversationEventTopicFaxStatus faxStatus

held

Boolean held

id

String id

initialState

QueueConversationEventTopicCall.InitialStateEnum initialState

muted

Boolean muted

other

QueueConversationEventTopicAddress other

peerId

String peerId

provider

String provider

recording

Boolean recording

recordingState

QueueConversationEventTopicCall.RecordingStateEnum recordingState

scriptId

String scriptId

securePause

Boolean securePause

self

QueueConversationEventTopicAddress self

startHoldTime

Date startHoldTime

state

QueueConversationEventTopicCall.StateEnum state

uuiData

String uuiData

wrapup

QueueConversationEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicCallback

class QueueConversationEventTopicCallback extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

automatedCallbackConfigId

String automatedCallbackConfigId

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Date callbackScheduledTime

callbackUserName

String callbackUserName

callerId

String callerId

callerIdName

String callerIdName

connectedTime

Date connectedTime

dialerPreview

QueueConversationEventTopicDialerPreview dialerPreview

direction

QueueConversationEventTopicCallback.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationEventTopicCallback.DisconnectTypeEnum disconnectType

externalCampaign

Boolean externalCampaign

held

Boolean held

id

String id

initialState

QueueConversationEventTopicCallback.InitialStateEnum initialState

peerId

String peerId

provider

String provider

scriptId

String scriptId

skipEnabled

Boolean skipEnabled

startHoldTime

Date startHoldTime

state

QueueConversationEventTopicCallback.StateEnum state

timeoutSeconds

Integer timeoutSeconds

voicemail

QueueConversationEventTopicVoicemail voicemail

wrapup

QueueConversationEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicChat

class QueueConversationEventTopicChat extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

avatarImageUrl

String avatarImageUrl

connectedTime

Date connectedTime

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationEventTopicChat.DisconnectTypeEnum disconnectType

held

Boolean held

id

String id

initialState

QueueConversationEventTopicChat.InitialStateEnum initialState

journeyContext

QueueConversationEventTopicJourneyContext journeyContext

peerId

String peerId

provider

String provider

roomId

String roomId

scriptId

String scriptId

startHoldTime

Date startHoldTime

state

QueueConversationEventTopicChat.StateEnum state

wrapup

QueueConversationEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicCobrowse

class QueueConversationEventTopicCobrowse extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

cobrowseRole

String cobrowseRole

cobrowseSessionId

String cobrowseSessionId

connectedTime

Date connectedTime

controlling

List<String> controlling

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationEventTopicCobrowse.DisconnectTypeEnum disconnectType

id

String id

initialState

QueueConversationEventTopicCobrowse.InitialStateEnum initialState

peerId

String peerId

provider

String provider

providerEventTime

Date providerEventTime

roomId

String roomId

scriptId

String scriptId

self

QueueConversationEventTopicAddress self

state

QueueConversationEventTopicCobrowse.StateEnum state

viewerUrl

String viewerUrl

wrapup

QueueConversationEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicConversation

class QueueConversationEventTopicConversation extends Object implements Serializable

Serialized Fields

address

String address

externalTag

String externalTag

id

String id

maxParticipants

Integer maxParticipants

participants

List<QueueConversationEventTopicParticipant> participants

recentTransfers

List<QueueConversationEventTopicRecentTransfer> recentTransfers

recordingState

String recordingState

securePause

Boolean securePause

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicConversationRoutingData

class QueueConversationEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

QueueConversationEventTopicUriReference language

priority

Integer priority

queue

QueueConversationEventTopicUriReference queue

scoredAgents

List<QueueConversationEventTopicScoredAgent> scoredAgents

skills

List<QueueConversationEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicDestination

class QueueConversationEventTopicDestination extends Object implements Serializable

Serialized Fields

address

String address

userId

String userId

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicDialerPreview

class QueueConversationEventTopicDialerPreview extends Object implements Serializable

Serialized Fields

campaignId

String campaignId

contactId

String contactId

contactListId

String contactListId

id

String id

phoneNumberColumns

List<QueueConversationEventTopicPhoneNumberColumn> phoneNumberColumns

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicDisconnectReason

class QueueConversationEventTopicDisconnectReason extends Object implements Serializable

Serialized Fields

code

Integer code

phrase

String phrase

type

QueueConversationEventTopicDisconnectReason.TypeEnum type

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicEmail

class QueueConversationEventTopicEmail extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

autoGenerated

Boolean autoGenerated

connectedTime

Date connectedTime

direction

QueueConversationEventTopicEmail.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationEventTopicEmail.DisconnectTypeEnum disconnectType

draftAttachments

List<QueueConversationEventTopicAttachment> draftAttachments

errorInfo

QueueConversationEventTopicErrorDetails errorInfo

held

Boolean held

id

String id

initialState

QueueConversationEventTopicEmail.InitialStateEnum initialState

messageId

String messageId

messagesSent

Integer messagesSent

peerId

String peerId

provider

String provider

scriptId

String scriptId

spam

Boolean spam

startHoldTime

Date startHoldTime

state

QueueConversationEventTopicEmail.StateEnum state

subject

String subject

wrapup

QueueConversationEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicErrorDetails

class QueueConversationEventTopicErrorDetails extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

uri

String uri

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicFaxStatus

class QueueConversationEventTopicFaxStatus extends Object implements Serializable

Serialized Fields

activePage

Integer activePage

baudRate

Integer baudRate

bytesTransmitted

Integer bytesTransmitted

direction

String direction

expectedPages

Integer expectedPages

lineErrors

Integer lineErrors

linesTransmitted

Integer linesTransmitted

pageErrors

Integer pageErrors

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicInitiator

class QueueConversationEventTopicInitiator extends Object implements Serializable

Serialized Fields

userId

String userId

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicJourneyAction

class QueueConversationEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

QueueConversationEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicJourneyActionMap

class QueueConversationEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicJourneyContext

class QueueConversationEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

QueueConversationEventTopicJourneyCustomer customer

customerSession

QueueConversationEventTopicJourneyCustomerSession customerSession

triggeringAction

QueueConversationEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicJourneyCustomer

class QueueConversationEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicJourneyCustomerSession

class QueueConversationEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicMessage

class QueueConversationEventTopicMessage extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

agentAssistantId

String agentAssistantId

byoSmsIntegrationId

String byoSmsIntegrationId

connectedTime

Date connectedTime

direction

QueueConversationEventTopicMessage.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationEventTopicMessage.DisconnectTypeEnum disconnectType

errorInfo

QueueConversationEventTopicErrorDetails errorInfo

fromAddress

QueueConversationEventTopicAddress fromAddress

held

Boolean held

id

String id

initialState

QueueConversationEventTopicMessage.InitialStateEnum initialState

journeyContext

QueueConversationEventTopicJourneyContext journeyContext

messages

List<QueueConversationEventTopicMessageDetails> messages

messagesTranscriptUri

String messagesTranscriptUri

peerId

String peerId

provider

String provider

recipientCountry

String recipientCountry

recipientType

String recipientType

scriptId

String scriptId

startHoldTime

Date startHoldTime

state

QueueConversationEventTopicMessage.StateEnum state

toAddress

QueueConversationEventTopicAddress toAddress

type

QueueConversationEventTopicMessage.TypeEnum type

wrapup

QueueConversationEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicMessageDetails

class QueueConversationEventTopicMessageDetails extends Object implements Serializable

Serialized Fields

errorInfo

QueueConversationEventTopicErrorDetails errorInfo

media

List<QueueConversationEventTopicMessageMedia> media

messageId

String messageId

messageMetadata

QueueConversationEventTopicMessageMetadata messageMetadata

messageSegmentCount

Integer messageSegmentCount

messageStatus

QueueConversationEventTopicMessageDetails.MessageStatusEnum messageStatus

messageTime

Date messageTime

stickers

List<QueueConversationEventTopicMessageSticker> stickers

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicMessageMedia

class QueueConversationEventTopicMessageMedia extends Object implements Serializable

Serialized Fields

contentLengthBytes

Integer contentLengthBytes

id

String id

mediaType

String mediaType

name

String name

url

String url

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicMessageMetadata

class QueueConversationEventTopicMessageMetadata extends Object implements Serializable

Serialized Fields

content

List<QueueConversationEventTopicMessageMetadataContent> content

events

List<QueueConversationEventTopicMessageMetadataEvent> events

type

String type

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicMessageMetadataContent

class QueueConversationEventTopicMessageMetadataContent extends Object implements Serializable

Serialized Fields

contentType

String contentType

subType

String subType

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicMessageMetadataEvent

class QueueConversationEventTopicMessageMetadataEvent extends Object implements Serializable

Serialized Fields

eventType

String eventType

subType

String subType

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicMessageSticker

class QueueConversationEventTopicMessageSticker extends Object implements Serializable

Serialized Fields

id

String id

url

String url

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicModifiedBy

class QueueConversationEventTopicModifiedBy extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicObject

class QueueConversationEventTopicObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicParticipant

class QueueConversationEventTopicParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

bargedParticipantId

String bargedParticipantId

callbacks

List<QueueConversationEventTopicCallback> callbacks

calls

List<QueueConversationEventTopicCall> calls

chats

List<QueueConversationEventTopicChat> chats

coachedParticipantId

String coachedParticipantId

cobrowsesessions

List<QueueConversationEventTopicCobrowse> cobrowsesessions

connectedTime

Date connectedTime

consultParticipantId

String consultParticipantId

conversationRoutingData

QueueConversationEventTopicConversationRoutingData conversationRoutingData

emails

List<QueueConversationEventTopicEmail> emails

endAcwTime

Date endAcwTime

endTime

Date endTime

externalContactId

String externalContactId

externalOrganizationId

String externalOrganizationId

flaggedReason

String flaggedReason

groupId

String groupId

id

String id

mediaRoles

List<String> mediaRoles

messages

List<QueueConversationEventTopicMessage> messages

monitoredParticipantId

String monitoredParticipantId

name

String name

purpose

String purpose

queueId

String queueId

screenRecordingState

QueueConversationEventTopicParticipant.ScreenRecordingStateEnum screenRecordingState

screenshares

List<QueueConversationEventTopicScreenshare> screenshares

socialExpressions

List<QueueConversationEventTopicSocialExpression> socialExpressions

startAcwTime

Date startAcwTime

teamId

String teamId

userId

String userId

videos

List<QueueConversationEventTopicVideo> videos

workflow

QueueConversationEventTopicWorkflow workflow

wrapup

QueueConversationEventTopicWrapup wrapup

wrapupExpected

Boolean wrapupExpected

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicPhoneNumberColumn

class QueueConversationEventTopicPhoneNumberColumn extends Object implements Serializable

Serialized Fields

columnName

String columnName

type

String type

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicRecentTransfer

class QueueConversationEventTopicRecentTransfer extends Object implements Serializable

Serialized Fields

dateIssued

Date dateIssued

destination

QueueConversationEventTopicDestination destination

id

String id

initiator

QueueConversationEventTopicInitiator initiator

modifiedBy

QueueConversationEventTopicModifiedBy modifiedBy

state

QueueConversationEventTopicRecentTransfer.StateEnum state

transferType

QueueConversationEventTopicRecentTransfer.TransferTypeEnum transferType

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicScoredAgent

class QueueConversationEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

QueueConversationEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicScreenshare

class QueueConversationEventTopicScreenshare extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

connectedTime

Date connectedTime

context

String context

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationEventTopicScreenshare.DisconnectTypeEnum disconnectType

id

String id

initialState

QueueConversationEventTopicScreenshare.InitialStateEnum initialState

peerCount

Object peerCount

peerId

String peerId

provider

String provider

scriptId

String scriptId

self

QueueConversationEventTopicAddress self

sharing

Boolean sharing

state

QueueConversationEventTopicScreenshare.StateEnum state

wrapup

QueueConversationEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicSocialExpression

class QueueConversationEventTopicSocialExpression extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

connectedTime

Date connectedTime

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationEventTopicSocialExpression.DisconnectTypeEnum disconnectType

held

Boolean held

id

String id

initialState

QueueConversationEventTopicSocialExpression.InitialStateEnum initialState

peerId

String peerId

previewText

String previewText

provider

String provider

recordingId

String recordingId

scriptId

String scriptId

socialMediaHub

String socialMediaHub

socialMediaId

String socialMediaId

socialUserName

String socialUserName

startHoldTime

Date startHoldTime

state

QueueConversationEventTopicSocialExpression.StateEnum state

wrapup

QueueConversationEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicUriReference

class QueueConversationEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicVideo

class QueueConversationEventTopicVideo extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

audioMuted

Boolean audioMuted

connectedTime

Date connectedTime

context

String context

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationEventTopicVideo.DisconnectTypeEnum disconnectType

id

String id

initialState

QueueConversationEventTopicVideo.InitialStateEnum initialState

msids

List<String> msids

peerCount

Object peerCount

peerId

String peerId

provider

String provider

scriptId

String scriptId

self

QueueConversationEventTopicAddress self

sharingScreen

Boolean sharingScreen

state

QueueConversationEventTopicVideo.StateEnum state

videoMuted

Boolean videoMuted

wrapup

QueueConversationEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicVoicemail

class QueueConversationEventTopicVoicemail extends Object implements Serializable

Serialized Fields

id

String id

uploadStatus

QueueConversationEventTopicVoicemail.UploadStatusEnum uploadStatus

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicWorkflow

class QueueConversationEventTopicWorkflow extends Object implements Serializable

Serialized Fields

workflowId

String workflowId

Class com.mypurecloud.sdk.v2.model.QueueConversationEventTopicWrapup

class QueueConversationEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicConversationRoutingData

class QueueConversationMessageEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

QueueConversationMessageEventTopicUriReference language

priority

Integer priority

queue

QueueConversationMessageEventTopicUriReference queue

scoredAgents

List<QueueConversationMessageEventTopicScoredAgent> scoredAgents

skills

List<QueueConversationMessageEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicDetail

class QueueConversationMessageEventTopicDetail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicErrorBody

class QueueConversationMessageEventTopicErrorBody extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

details

List<QueueConversationMessageEventTopicDetail> details

entityId

String entityId

entityName

String entityName

errors

List<QueueConversationMessageEventTopicErrorBody> errors

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicErrorDetails

class QueueConversationMessageEventTopicErrorDetails extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

uri

String uri

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicJourneyAction

class QueueConversationMessageEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

QueueConversationMessageEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicJourneyActionMap

class QueueConversationMessageEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicJourneyContext

class QueueConversationMessageEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

QueueConversationMessageEventTopicJourneyCustomer customer

customerSession

QueueConversationMessageEventTopicJourneyCustomerSession customerSession

triggeringAction

QueueConversationMessageEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicJourneyCustomer

class QueueConversationMessageEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicJourneyCustomerSession

class QueueConversationMessageEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicMessageConversation

class QueueConversationMessageEventTopicMessageConversation extends Object implements Serializable

Serialized Fields

id

String id

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<QueueConversationMessageEventTopicMessageMediaParticipant> participants

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicMessageDetails

class QueueConversationMessageEventTopicMessageDetails extends Object implements Serializable

Serialized Fields

errorInfo

QueueConversationMessageEventTopicErrorDetails errorInfo

media

List<QueueConversationMessageEventTopicMessageMedia> media

message

QueueConversationMessageEventTopicUriReference message

messageMetadata

QueueConversationMessageEventTopicMessageMetadata messageMetadata

messageSegmentCount

Integer messageSegmentCount

messageStatus

QueueConversationMessageEventTopicMessageDetails.MessageStatusEnum messageStatus

messageTime

Date messageTime

stickers

List<QueueConversationMessageEventTopicMessageSticker> stickers

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicMessageMedia

class QueueConversationMessageEventTopicMessageMedia extends Object implements Serializable

Serialized Fields

contentLengthBytes

Integer contentLengthBytes

id

String id

mediaType

String mediaType

name

String name

url

String url

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicMessageMediaParticipant

class QueueConversationMessageEventTopicMessageMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

byoSmsIntegrationId

String byoSmsIntegrationId

connectedTime

Date connectedTime

conversationRoutingData

QueueConversationMessageEventTopicConversationRoutingData conversationRoutingData

direction

QueueConversationMessageEventTopicMessageMediaParticipant.DirectionEnum direction

disconnectType

QueueConversationMessageEventTopicMessageMediaParticipant.DisconnectTypeEnum disconnectType

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

QueueConversationMessageEventTopicErrorBody errorInfo

externalContact

QueueConversationMessageEventTopicUriReference externalContact

externalOrganization

QueueConversationMessageEventTopicUriReference externalOrganization

flaggedReason

QueueConversationMessageEventTopicMessageMediaParticipant.FlaggedReasonEnum flaggedReason

held

Boolean held

id

String id

initialState

QueueConversationMessageEventTopicMessageMediaParticipant.InitialStateEnum initialState

journeyContext

QueueConversationMessageEventTopicJourneyContext journeyContext

mediaRoles

List<String> mediaRoles

messages

List<QueueConversationMessageEventTopicMessageDetails> messages

monitoredParticipantId

String monitoredParticipantId

name

String name

peer

String peer

provider

String provider

purpose

String purpose

queue

QueueConversationMessageEventTopicUriReference queue

recipientCountry

String recipientCountry

recipientType

String recipientType

screenRecordingState

String screenRecordingState

script

QueueConversationMessageEventTopicUriReference script

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

QueueConversationMessageEventTopicMessageMediaParticipant.StateEnum state

team

QueueConversationMessageEventTopicUriReference team

type

QueueConversationMessageEventTopicMessageMediaParticipant.TypeEnum type

user

QueueConversationMessageEventTopicUriReference user

wrapup

QueueConversationMessageEventTopicWrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicMessageMetadata

class QueueConversationMessageEventTopicMessageMetadata extends Object implements Serializable

Serialized Fields

content

List<QueueConversationMessageEventTopicMessageMetadataContent> content

events

List<QueueConversationMessageEventTopicMessageMetadataEvent> events

type

String type

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicMessageMetadataContent

class QueueConversationMessageEventTopicMessageMetadataContent extends Object implements Serializable

Serialized Fields

contentType

String contentType

subType

String subType

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicMessageMetadataEvent

class QueueConversationMessageEventTopicMessageMetadataEvent extends Object implements Serializable

Serialized Fields

eventType

String eventType

subType

String subType

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicMessageSticker

class QueueConversationMessageEventTopicMessageSticker extends Object implements Serializable

Serialized Fields

id

String id

url

String url

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicScoredAgent

class QueueConversationMessageEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

QueueConversationMessageEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicUriReference

class QueueConversationMessageEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.QueueConversationMessageEventTopicWrapup

class QueueConversationMessageEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.QueueConversationScreenShareEventTopicConversationRoutingData

class QueueConversationScreenShareEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

QueueConversationScreenShareEventTopicUriReference language

priority

Integer priority

queue

QueueConversationScreenShareEventTopicUriReference queue

scoredAgents

List<QueueConversationScreenShareEventTopicScoredAgent> scoredAgents

skills

List<QueueConversationScreenShareEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.QueueConversationScreenShareEventTopicDetail

class QueueConversationScreenShareEventTopicDetail extends Object implements Serializable

Serialized Fields

entityId

String entityId

entityName

String entityName

errorCode

String errorCode

fieldName

String fieldName

Class com.mypurecloud.sdk.v2.model.QueueConversationScreenShareEventTopicErrorBody

class QueueConversationScreenShareEventTopicErrorBody extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

details

List<QueueConversationScreenShareEventTopicDetail> details

entityId

String entityId

entityName

String entityName

errors

List<QueueConversationScreenShareEventTopicErrorBody> errors

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.QueueConversationScreenShareEventTopicJourneyAction

class QueueConversationScreenShareEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

QueueConversationScreenShareEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.QueueConversationScreenShareEventTopicJourneyActionMap

class QueueConversationScreenShareEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.QueueConversationScreenShareEventTopicJourneyContext

class QueueConversationScreenShareEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

QueueConversationScreenShareEventTopicJourneyCustomer customer

customerSession

QueueConversationScreenShareEventTopicJourneyCustomerSession customerSession

triggeringAction

QueueConversationScreenShareEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.QueueConversationScreenShareEventTopicJourneyCustomer

class QueueConversationScreenShareEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.QueueConversationScreenShareEventTopicJourneyCustomerSession

class QueueConversationScreenShareEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.QueueConversationScreenShareEventTopicScoredAgent

class QueueConversationScreenShareEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

QueueConversationScreenShareEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.QueueConversationScreenShareEventTopicScreenShareConversation

class QueueConversationScreenShareEventTopicScreenShareConversation extends Object implements Serializable

Serialized Fields

id

String id

name

String name

otherMediaUris

List<String> otherMediaUris

participants

List<QueueConversationScreenShareEventTopicScreenShareMediaParticipant> participants

Class com.mypurecloud.sdk.v2.model.QueueConversationScreenShareEventTopicScreenShareMediaParticipant

class QueueConversationScreenShareEventTopicScreenShareMediaParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

connectedTime

Date connectedTime

context

String context

conversationRoutingData

QueueConversationScreenShareEventTopicConversationRoutingData conversationRoutingData

direction

QueueConversationScreenShareEventTopicScreenShareMediaParticipant.DirectionEnum direction

disconnectType

QueueConversationScreenShareEventTopicScreenShareMediaParticipant.DisconnectTypeEnum disconnectType

endAcwTime

Date endAcwTime

endTime

Date endTime

errorInfo

QueueConversationScreenShareEventTopicErrorBody errorInfo

externalContact

QueueConversationScreenShareEventTopicUriReference externalContact

externalOrganization

QueueConversationScreenShareEventTopicUriReference externalOrganization

flaggedReason

QueueConversationScreenShareEventTopicScreenShareMediaParticipant.FlaggedReasonEnum flaggedReason

held

Boolean held

id

String id

initialState

QueueConversationScreenShareEventTopicScreenShareMediaParticipant.InitialStateEnum initialState

journeyContext

QueueConversationScreenShareEventTopicJourneyContext journeyContext

mediaRoles

List<String> mediaRoles

name

String name

peer

String peer

peerCount

Integer peerCount

provider

String provider

purpose

String purpose

queue

QueueConversationScreenShareEventTopicUriReference queue

screenRecordingState

String screenRecordingState

script

QueueConversationScreenShareEventTopicUriReference script

sharing

Boolean sharing

startAcwTime

Date startAcwTime

startHoldTime

Date startHoldTime

startTime

Date startTime

state

QueueConversationScreenShareEventTopicScreenShareMediaParticipant.StateEnum state

team

QueueConversationScreenShareEventTopicUriReference team

user

QueueConversationScreenShareEventTopicUriReference user

wrapup

QueueConversationScreenShareEventTopicWrapup wrapup

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupSkipped

Boolean wrapupSkipped

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.QueueConversationScreenShareEventTopicUriReference

class QueueConversationScreenShareEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.QueueConversationScreenShareEventTopicWrapup

class QueueConversationScreenShareEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicAddress

class QueueConversationSocialExpressionEventTopicAddress extends Object implements Serializable

Serialized Fields

addressDisplayable

String addressDisplayable

addressNormalized

String addressNormalized

addressRaw

String addressRaw

name

String name

nameRaw

String nameRaw

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicAfterCallWork

class QueueConversationSocialExpressionEventTopicAfterCallWork extends Object implements Serializable

Serialized Fields

endTime

Date endTime

startTime

Date startTime

state

QueueConversationSocialExpressionEventTopicAfterCallWork.StateEnum state

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicAttachment

class QueueConversationSocialExpressionEventTopicAttachment extends Object implements Serializable

Serialized Fields

attachmentId

String attachmentId

contentLength

Integer contentLength

contentType

String contentType

contentUri

String contentUri

name

String name

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicCall

class QueueConversationSocialExpressionEventTopicCall extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationSocialExpressionEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

agentAssistantId

String agentAssistantId

bargedTime

Date bargedTime

confined

Boolean confined

connectedTime

Date connectedTime

direction

QueueConversationSocialExpressionEventTopicCall.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectReasons

List<QueueConversationSocialExpressionEventTopicDisconnectReason> disconnectReasons

disconnectType

QueueConversationSocialExpressionEventTopicCall.DisconnectTypeEnum disconnectType

documentId

String documentId

errorInfo

QueueConversationSocialExpressionEventTopicErrorDetails errorInfo

faxStatus

QueueConversationSocialExpressionEventTopicFaxStatus faxStatus

held

Boolean held

id

String id

initialState

QueueConversationSocialExpressionEventTopicCall.InitialStateEnum initialState

muted

Boolean muted

other

QueueConversationSocialExpressionEventTopicAddress other

peerId

String peerId

provider

String provider

recording

Boolean recording

recordingState

QueueConversationSocialExpressionEventTopicCall.RecordingStateEnum recordingState

scriptId

String scriptId

securePause

Boolean securePause

self

QueueConversationSocialExpressionEventTopicAddress self

startHoldTime

Date startHoldTime

state

QueueConversationSocialExpressionEventTopicCall.StateEnum state

uuiData

String uuiData

wrapup

QueueConversationSocialExpressionEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicCallback

class QueueConversationSocialExpressionEventTopicCallback extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationSocialExpressionEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

automatedCallbackConfigId

String automatedCallbackConfigId

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Date callbackScheduledTime

callbackUserName

String callbackUserName

callerId

String callerId

callerIdName

String callerIdName

connectedTime

Date connectedTime

dialerPreview

QueueConversationSocialExpressionEventTopicDialerPreview dialerPreview

direction

QueueConversationSocialExpressionEventTopicCallback.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationSocialExpressionEventTopicCallback.DisconnectTypeEnum disconnectType

externalCampaign

Boolean externalCampaign

held

Boolean held

id

String id

initialState

QueueConversationSocialExpressionEventTopicCallback.InitialStateEnum initialState

peerId

String peerId

provider

String provider

scriptId

String scriptId

skipEnabled

Boolean skipEnabled

startHoldTime

Date startHoldTime

state

QueueConversationSocialExpressionEventTopicCallback.StateEnum state

timeoutSeconds

Integer timeoutSeconds

voicemail

QueueConversationSocialExpressionEventTopicVoicemail voicemail

wrapup

QueueConversationSocialExpressionEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicChat

class QueueConversationSocialExpressionEventTopicChat extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationSocialExpressionEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

avatarImageUrl

String avatarImageUrl

connectedTime

Date connectedTime

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationSocialExpressionEventTopicChat.DisconnectTypeEnum disconnectType

held

Boolean held

id

String id

initialState

QueueConversationSocialExpressionEventTopicChat.InitialStateEnum initialState

journeyContext

QueueConversationSocialExpressionEventTopicJourneyContext journeyContext

peerId

String peerId

provider

String provider

roomId

String roomId

scriptId

String scriptId

startHoldTime

Date startHoldTime

state

QueueConversationSocialExpressionEventTopicChat.StateEnum state

wrapup

QueueConversationSocialExpressionEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicCobrowse

class QueueConversationSocialExpressionEventTopicCobrowse extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationSocialExpressionEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

cobrowseRole

String cobrowseRole

cobrowseSessionId

String cobrowseSessionId

connectedTime

Date connectedTime

controlling

List<String> controlling

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationSocialExpressionEventTopicCobrowse.DisconnectTypeEnum disconnectType

id

String id

initialState

QueueConversationSocialExpressionEventTopicCobrowse.InitialStateEnum initialState

peerId

String peerId

provider

String provider

providerEventTime

Date providerEventTime

roomId

String roomId

scriptId

String scriptId

self

QueueConversationSocialExpressionEventTopicAddress self

state

QueueConversationSocialExpressionEventTopicCobrowse.StateEnum state

viewerUrl

String viewerUrl

wrapup

QueueConversationSocialExpressionEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicConversation

class QueueConversationSocialExpressionEventTopicConversation extends Object implements Serializable

Serialized Fields

address

String address

externalTag

String externalTag

id

String id

maxParticipants

Integer maxParticipants

participants

List<QueueConversationSocialExpressionEventTopicParticipant> participants

recentTransfers

List<QueueConversationSocialExpressionEventTopicRecentTransfer> recentTransfers

recordingState

String recordingState

securePause

Boolean securePause

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicConversationRoutingData

class QueueConversationSocialExpressionEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

QueueConversationSocialExpressionEventTopicUriReference language

priority

Integer priority

queue

QueueConversationSocialExpressionEventTopicUriReference queue

scoredAgents

List<QueueConversationSocialExpressionEventTopicScoredAgent> scoredAgents

skills

List<QueueConversationSocialExpressionEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicDestination

class QueueConversationSocialExpressionEventTopicDestination extends Object implements Serializable

Serialized Fields

address

String address

userId

String userId

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicDialerPreview

class QueueConversationSocialExpressionEventTopicDialerPreview extends Object implements Serializable

Serialized Fields

campaignId

String campaignId

contactId

String contactId

contactListId

String contactListId

id

String id

phoneNumberColumns

List<QueueConversationSocialExpressionEventTopicPhoneNumberColumn> phoneNumberColumns

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicDisconnectReason

class QueueConversationSocialExpressionEventTopicDisconnectReason extends Object implements Serializable

Serialized Fields

code

Integer code

phrase

String phrase

type

QueueConversationSocialExpressionEventTopicDisconnectReason.TypeEnum type

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicEmail

class QueueConversationSocialExpressionEventTopicEmail extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationSocialExpressionEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

autoGenerated

Boolean autoGenerated

connectedTime

Date connectedTime

direction

QueueConversationSocialExpressionEventTopicEmail.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationSocialExpressionEventTopicEmail.DisconnectTypeEnum disconnectType

draftAttachments

List<QueueConversationSocialExpressionEventTopicAttachment> draftAttachments

errorInfo

QueueConversationSocialExpressionEventTopicErrorDetails errorInfo

held

Boolean held

id

String id

initialState

QueueConversationSocialExpressionEventTopicEmail.InitialStateEnum initialState

messageId

String messageId

messagesSent

Integer messagesSent

peerId

String peerId

provider

String provider

scriptId

String scriptId

spam

Boolean spam

startHoldTime

Date startHoldTime

state

QueueConversationSocialExpressionEventTopicEmail.StateEnum state

subject

String subject

wrapup

QueueConversationSocialExpressionEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicErrorDetails

class QueueConversationSocialExpressionEventTopicErrorDetails extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

uri

String uri

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicFaxStatus

class QueueConversationSocialExpressionEventTopicFaxStatus extends Object implements Serializable

Serialized Fields

activePage

Integer activePage

baudRate

Integer baudRate

bytesTransmitted

Integer bytesTransmitted

direction

String direction

expectedPages

Integer expectedPages

lineErrors

Integer lineErrors

linesTransmitted

Integer linesTransmitted

pageErrors

Integer pageErrors

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicInitiator

class QueueConversationSocialExpressionEventTopicInitiator extends Object implements Serializable

Serialized Fields

userId

String userId

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicJourneyAction

class QueueConversationSocialExpressionEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

QueueConversationSocialExpressionEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicJourneyActionMap

class QueueConversationSocialExpressionEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicJourneyContext

class QueueConversationSocialExpressionEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

QueueConversationSocialExpressionEventTopicJourneyCustomer customer

customerSession

QueueConversationSocialExpressionEventTopicJourneyCustomerSession customerSession

triggeringAction

QueueConversationSocialExpressionEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicJourneyCustomer

class QueueConversationSocialExpressionEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicJourneyCustomerSession

class QueueConversationSocialExpressionEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicMessage

class QueueConversationSocialExpressionEventTopicMessage extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationSocialExpressionEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

agentAssistantId

String agentAssistantId

byoSmsIntegrationId

String byoSmsIntegrationId

connectedTime

Date connectedTime

direction

QueueConversationSocialExpressionEventTopicMessage.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationSocialExpressionEventTopicMessage.DisconnectTypeEnum disconnectType

errorInfo

QueueConversationSocialExpressionEventTopicErrorDetails errorInfo

fromAddress

QueueConversationSocialExpressionEventTopicAddress fromAddress

held

Boolean held

id

String id

initialState

QueueConversationSocialExpressionEventTopicMessage.InitialStateEnum initialState

journeyContext

QueueConversationSocialExpressionEventTopicJourneyContext journeyContext

messages

List<QueueConversationSocialExpressionEventTopicMessageDetails> messages

messagesTranscriptUri

String messagesTranscriptUri

peerId

String peerId

provider

String provider

recipientCountry

String recipientCountry

recipientType

String recipientType

scriptId

String scriptId

startHoldTime

Date startHoldTime

state

QueueConversationSocialExpressionEventTopicMessage.StateEnum state

toAddress

QueueConversationSocialExpressionEventTopicAddress toAddress

type

QueueConversationSocialExpressionEventTopicMessage.TypeEnum type

wrapup

QueueConversationSocialExpressionEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicMessageDetails

class QueueConversationSocialExpressionEventTopicMessageDetails extends Object implements Serializable

Serialized Fields

errorInfo

QueueConversationSocialExpressionEventTopicErrorDetails errorInfo

media

List<QueueConversationSocialExpressionEventTopicMessageMedia> media

messageId

String messageId

messageMetadata

QueueConversationSocialExpressionEventTopicMessageMetadata messageMetadata

messageSegmentCount

Integer messageSegmentCount

messageStatus

QueueConversationSocialExpressionEventTopicMessageDetails.MessageStatusEnum messageStatus

messageTime

Date messageTime

stickers

List<QueueConversationSocialExpressionEventTopicMessageSticker> stickers

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicMessageMedia

class QueueConversationSocialExpressionEventTopicMessageMedia extends Object implements Serializable

Serialized Fields

contentLengthBytes

Integer contentLengthBytes

id

String id

mediaType

String mediaType

name

String name

url

String url

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicMessageMetadata

class QueueConversationSocialExpressionEventTopicMessageMetadata extends Object implements Serializable

Serialized Fields

content

List<QueueConversationSocialExpressionEventTopicMessageMetadataContent> content

events

List<QueueConversationSocialExpressionEventTopicMessageMetadataEvent> events

type

String type

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicMessageMetadataContent

class QueueConversationSocialExpressionEventTopicMessageMetadataContent extends Object implements Serializable

Serialized Fields

contentType

String contentType

subType

String subType

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicMessageMetadataEvent

class QueueConversationSocialExpressionEventTopicMessageMetadataEvent extends Object implements Serializable

Serialized Fields

eventType

String eventType

subType

String subType

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicMessageSticker

class QueueConversationSocialExpressionEventTopicMessageSticker extends Object implements Serializable

Serialized Fields

id

String id

url

String url

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicModifiedBy

class QueueConversationSocialExpressionEventTopicModifiedBy extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicObject

class QueueConversationSocialExpressionEventTopicObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicParticipant

class QueueConversationSocialExpressionEventTopicParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

bargedParticipantId

String bargedParticipantId

callbacks

List<QueueConversationSocialExpressionEventTopicCallback> callbacks

calls

List<QueueConversationSocialExpressionEventTopicCall> calls

chats

List<QueueConversationSocialExpressionEventTopicChat> chats

coachedParticipantId

String coachedParticipantId

cobrowsesessions

List<QueueConversationSocialExpressionEventTopicCobrowse> cobrowsesessions

connectedTime

Date connectedTime

consultParticipantId

String consultParticipantId

conversationRoutingData

QueueConversationSocialExpressionEventTopicConversationRoutingData conversationRoutingData

emails

List<QueueConversationSocialExpressionEventTopicEmail> emails

endAcwTime

Date endAcwTime

endTime

Date endTime

externalContactId

String externalContactId

externalOrganizationId

String externalOrganizationId

flaggedReason

String flaggedReason

groupId

String groupId

id

String id

mediaRoles

List<String> mediaRoles

messages

List<QueueConversationSocialExpressionEventTopicMessage> messages

monitoredParticipantId

String monitoredParticipantId

name

String name

purpose

String purpose

queueId

String queueId

screenRecordingState

QueueConversationSocialExpressionEventTopicParticipant.ScreenRecordingStateEnum screenRecordingState

screenshares

List<QueueConversationSocialExpressionEventTopicScreenshare> screenshares

socialExpressions

List<QueueConversationSocialExpressionEventTopicSocialExpression> socialExpressions

startAcwTime

Date startAcwTime

teamId

String teamId

userId

String userId

videos

List<QueueConversationSocialExpressionEventTopicVideo> videos

workflow

QueueConversationSocialExpressionEventTopicWorkflow workflow

wrapup

QueueConversationSocialExpressionEventTopicWrapup wrapup

wrapupExpected

Boolean wrapupExpected

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicPhoneNumberColumn

class QueueConversationSocialExpressionEventTopicPhoneNumberColumn extends Object implements Serializable

Serialized Fields

columnName

String columnName

type

String type

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicRecentTransfer

class QueueConversationSocialExpressionEventTopicRecentTransfer extends Object implements Serializable

Serialized Fields

dateIssued

Date dateIssued

destination

QueueConversationSocialExpressionEventTopicDestination destination

id

String id

initiator

QueueConversationSocialExpressionEventTopicInitiator initiator

modifiedBy

QueueConversationSocialExpressionEventTopicModifiedBy modifiedBy

state

QueueConversationSocialExpressionEventTopicRecentTransfer.StateEnum state

transferType

QueueConversationSocialExpressionEventTopicRecentTransfer.TransferTypeEnum transferType

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicScoredAgent

class QueueConversationSocialExpressionEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

QueueConversationSocialExpressionEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicScreenshare

class QueueConversationSocialExpressionEventTopicScreenshare extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationSocialExpressionEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

connectedTime

Date connectedTime

context

String context

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationSocialExpressionEventTopicScreenshare.DisconnectTypeEnum disconnectType

id

String id

initialState

QueueConversationSocialExpressionEventTopicScreenshare.InitialStateEnum initialState

peerCount

Object peerCount

peerId

String peerId

provider

String provider

scriptId

String scriptId

self

QueueConversationSocialExpressionEventTopicAddress self

sharing

Boolean sharing

state

QueueConversationSocialExpressionEventTopicScreenshare.StateEnum state

wrapup

QueueConversationSocialExpressionEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicSocialExpression

class QueueConversationSocialExpressionEventTopicSocialExpression extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationSocialExpressionEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

connectedTime

Date connectedTime

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationSocialExpressionEventTopicSocialExpression.DisconnectTypeEnum disconnectType

held

Boolean held

id

String id

initialState

QueueConversationSocialExpressionEventTopicSocialExpression.InitialStateEnum initialState

peerId

String peerId

previewText

String previewText

provider

String provider

recordingId

String recordingId

scriptId

String scriptId

socialMediaHub

String socialMediaHub

socialMediaId

String socialMediaId

socialUserName

String socialUserName

startHoldTime

Date startHoldTime

state

QueueConversationSocialExpressionEventTopicSocialExpression.StateEnum state

wrapup

QueueConversationSocialExpressionEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicUriReference

class QueueConversationSocialExpressionEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicVideo

class QueueConversationSocialExpressionEventTopicVideo extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationSocialExpressionEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

audioMuted

Boolean audioMuted

connectedTime

Date connectedTime

context

String context

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationSocialExpressionEventTopicVideo.DisconnectTypeEnum disconnectType

id

String id

initialState

QueueConversationSocialExpressionEventTopicVideo.InitialStateEnum initialState

msids

List<String> msids

peerCount

Object peerCount

peerId

String peerId

provider

String provider

scriptId

String scriptId

self

QueueConversationSocialExpressionEventTopicAddress self

sharingScreen

Boolean sharingScreen

state

QueueConversationSocialExpressionEventTopicVideo.StateEnum state

videoMuted

Boolean videoMuted

wrapup

QueueConversationSocialExpressionEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicVoicemail

class QueueConversationSocialExpressionEventTopicVoicemail extends Object implements Serializable

Serialized Fields

id

String id

uploadStatus

QueueConversationSocialExpressionEventTopicVoicemail.UploadStatusEnum uploadStatus

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicWorkflow

class QueueConversationSocialExpressionEventTopicWorkflow extends Object implements Serializable

Serialized Fields

workflowId

String workflowId

Class com.mypurecloud.sdk.v2.model.QueueConversationSocialExpressionEventTopicWrapup

class QueueConversationSocialExpressionEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicAddress

class QueueConversationVideoEventTopicAddress extends Object implements Serializable

Serialized Fields

addressDisplayable

String addressDisplayable

addressNormalized

String addressNormalized

addressRaw

String addressRaw

name

String name

nameRaw

String nameRaw

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicAfterCallWork

class QueueConversationVideoEventTopicAfterCallWork extends Object implements Serializable

Serialized Fields

endTime

Date endTime

startTime

Date startTime

state

QueueConversationVideoEventTopicAfterCallWork.StateEnum state

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicAttachment

class QueueConversationVideoEventTopicAttachment extends Object implements Serializable

Serialized Fields

attachmentId

String attachmentId

contentLength

Integer contentLength

contentType

String contentType

contentUri

String contentUri

name

String name

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicCall

class QueueConversationVideoEventTopicCall extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationVideoEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

agentAssistantId

String agentAssistantId

bargedTime

Date bargedTime

confined

Boolean confined

connectedTime

Date connectedTime

direction

QueueConversationVideoEventTopicCall.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectReasons

List<QueueConversationVideoEventTopicDisconnectReason> disconnectReasons

disconnectType

QueueConversationVideoEventTopicCall.DisconnectTypeEnum disconnectType

documentId

String documentId

errorInfo

QueueConversationVideoEventTopicErrorDetails errorInfo

faxStatus

QueueConversationVideoEventTopicFaxStatus faxStatus

held

Boolean held

id

String id

initialState

QueueConversationVideoEventTopicCall.InitialStateEnum initialState

muted

Boolean muted

other

QueueConversationVideoEventTopicAddress other

peerId

String peerId

provider

String provider

recording

Boolean recording

recordingState

QueueConversationVideoEventTopicCall.RecordingStateEnum recordingState

scriptId

String scriptId

securePause

Boolean securePause

self

QueueConversationVideoEventTopicAddress self

startHoldTime

Date startHoldTime

state

QueueConversationVideoEventTopicCall.StateEnum state

uuiData

String uuiData

wrapup

QueueConversationVideoEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicCallback

class QueueConversationVideoEventTopicCallback extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationVideoEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

automatedCallbackConfigId

String automatedCallbackConfigId

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Date callbackScheduledTime

callbackUserName

String callbackUserName

callerId

String callerId

callerIdName

String callerIdName

connectedTime

Date connectedTime

dialerPreview

QueueConversationVideoEventTopicDialerPreview dialerPreview

direction

QueueConversationVideoEventTopicCallback.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationVideoEventTopicCallback.DisconnectTypeEnum disconnectType

externalCampaign

Boolean externalCampaign

held

Boolean held

id

String id

initialState

QueueConversationVideoEventTopicCallback.InitialStateEnum initialState

peerId

String peerId

provider

String provider

scriptId

String scriptId

skipEnabled

Boolean skipEnabled

startHoldTime

Date startHoldTime

state

QueueConversationVideoEventTopicCallback.StateEnum state

timeoutSeconds

Integer timeoutSeconds

voicemail

QueueConversationVideoEventTopicVoicemail voicemail

wrapup

QueueConversationVideoEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicChat

class QueueConversationVideoEventTopicChat extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationVideoEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

avatarImageUrl

String avatarImageUrl

connectedTime

Date connectedTime

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationVideoEventTopicChat.DisconnectTypeEnum disconnectType

held

Boolean held

id

String id

initialState

QueueConversationVideoEventTopicChat.InitialStateEnum initialState

journeyContext

QueueConversationVideoEventTopicJourneyContext journeyContext

peerId

String peerId

provider

String provider

roomId

String roomId

scriptId

String scriptId

startHoldTime

Date startHoldTime

state

QueueConversationVideoEventTopicChat.StateEnum state

wrapup

QueueConversationVideoEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicCobrowse

class QueueConversationVideoEventTopicCobrowse extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationVideoEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

cobrowseRole

String cobrowseRole

cobrowseSessionId

String cobrowseSessionId

connectedTime

Date connectedTime

controlling

List<String> controlling

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationVideoEventTopicCobrowse.DisconnectTypeEnum disconnectType

id

String id

initialState

QueueConversationVideoEventTopicCobrowse.InitialStateEnum initialState

peerId

String peerId

provider

String provider

providerEventTime

Date providerEventTime

roomId

String roomId

scriptId

String scriptId

self

QueueConversationVideoEventTopicAddress self

state

QueueConversationVideoEventTopicCobrowse.StateEnum state

viewerUrl

String viewerUrl

wrapup

QueueConversationVideoEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicConversation

class QueueConversationVideoEventTopicConversation extends Object implements Serializable

Serialized Fields

address

String address

externalTag

String externalTag

id

String id

maxParticipants

Integer maxParticipants

participants

List<QueueConversationVideoEventTopicParticipant> participants

recentTransfers

List<QueueConversationVideoEventTopicRecentTransfer> recentTransfers

recordingState

String recordingState

securePause

Boolean securePause

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicConversationRoutingData

class QueueConversationVideoEventTopicConversationRoutingData extends Object implements Serializable

Serialized Fields

language

QueueConversationVideoEventTopicUriReference language

priority

Integer priority

queue

QueueConversationVideoEventTopicUriReference queue

scoredAgents

List<QueueConversationVideoEventTopicScoredAgent> scoredAgents

skills

List<QueueConversationVideoEventTopicUriReference> skills

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicDestination

class QueueConversationVideoEventTopicDestination extends Object implements Serializable

Serialized Fields

address

String address

userId

String userId

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicDialerPreview

class QueueConversationVideoEventTopicDialerPreview extends Object implements Serializable

Serialized Fields

campaignId

String campaignId

contactId

String contactId

contactListId

String contactListId

id

String id

phoneNumberColumns

List<QueueConversationVideoEventTopicPhoneNumberColumn> phoneNumberColumns

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicDisconnectReason

class QueueConversationVideoEventTopicDisconnectReason extends Object implements Serializable

Serialized Fields

code

Integer code

phrase

String phrase

type

QueueConversationVideoEventTopicDisconnectReason.TypeEnum type

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicEmail

class QueueConversationVideoEventTopicEmail extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationVideoEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

autoGenerated

Boolean autoGenerated

connectedTime

Date connectedTime

direction

QueueConversationVideoEventTopicEmail.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationVideoEventTopicEmail.DisconnectTypeEnum disconnectType

draftAttachments

List<QueueConversationVideoEventTopicAttachment> draftAttachments

errorInfo

QueueConversationVideoEventTopicErrorDetails errorInfo

held

Boolean held

id

String id

initialState

QueueConversationVideoEventTopicEmail.InitialStateEnum initialState

messageId

String messageId

messagesSent

Integer messagesSent

peerId

String peerId

provider

String provider

scriptId

String scriptId

spam

Boolean spam

startHoldTime

Date startHoldTime

state

QueueConversationVideoEventTopicEmail.StateEnum state

subject

String subject

wrapup

QueueConversationVideoEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicErrorDetails

class QueueConversationVideoEventTopicErrorDetails extends Object implements Serializable

Serialized Fields

code

String code

contextId

String contextId

message

String message

messageParams

Map<String,String> messageParams

messageWithParams

String messageWithParams

status

Integer status

uri

String uri

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicFaxStatus

class QueueConversationVideoEventTopicFaxStatus extends Object implements Serializable

Serialized Fields

activePage

Integer activePage

baudRate

Integer baudRate

bytesTransmitted

Integer bytesTransmitted

direction

String direction

expectedPages

Integer expectedPages

lineErrors

Integer lineErrors

linesTransmitted

Integer linesTransmitted

pageErrors

Integer pageErrors

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicInitiator

class QueueConversationVideoEventTopicInitiator extends Object implements Serializable

Serialized Fields

userId

String userId

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicJourneyAction

class QueueConversationVideoEventTopicJourneyAction extends Object implements Serializable

Serialized Fields

actionMap

QueueConversationVideoEventTopicJourneyActionMap actionMap

id

String id

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicJourneyActionMap

class QueueConversationVideoEventTopicJourneyActionMap extends Object implements Serializable

Serialized Fields

id

String id

version

Integer version

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicJourneyContext

class QueueConversationVideoEventTopicJourneyContext extends Object implements Serializable

Serialized Fields

customer

QueueConversationVideoEventTopicJourneyCustomer customer

customerSession

QueueConversationVideoEventTopicJourneyCustomerSession customerSession

triggeringAction

QueueConversationVideoEventTopicJourneyAction triggeringAction

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicJourneyCustomer

class QueueConversationVideoEventTopicJourneyCustomer extends Object implements Serializable

Serialized Fields

id

String id

idType

String idType

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicJourneyCustomerSession

class QueueConversationVideoEventTopicJourneyCustomerSession extends Object implements Serializable

Serialized Fields

id

String id

type

String type

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicMessage

class QueueConversationVideoEventTopicMessage extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationVideoEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

agentAssistantId

String agentAssistantId

byoSmsIntegrationId

String byoSmsIntegrationId

connectedTime

Date connectedTime

direction

QueueConversationVideoEventTopicMessage.DirectionEnum direction

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationVideoEventTopicMessage.DisconnectTypeEnum disconnectType

errorInfo

QueueConversationVideoEventTopicErrorDetails errorInfo

fromAddress

QueueConversationVideoEventTopicAddress fromAddress

held

Boolean held

id

String id

initialState

QueueConversationVideoEventTopicMessage.InitialStateEnum initialState

journeyContext

QueueConversationVideoEventTopicJourneyContext journeyContext

messages

List<QueueConversationVideoEventTopicMessageDetails> messages

messagesTranscriptUri

String messagesTranscriptUri

peerId

String peerId

provider

String provider

recipientCountry

String recipientCountry

recipientType

String recipientType

scriptId

String scriptId

startHoldTime

Date startHoldTime

state

QueueConversationVideoEventTopicMessage.StateEnum state

toAddress

QueueConversationVideoEventTopicAddress toAddress

type

QueueConversationVideoEventTopicMessage.TypeEnum type

wrapup

QueueConversationVideoEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicMessageDetails

class QueueConversationVideoEventTopicMessageDetails extends Object implements Serializable

Serialized Fields

errorInfo

QueueConversationVideoEventTopicErrorDetails errorInfo

media

List<QueueConversationVideoEventTopicMessageMedia> media

messageId

String messageId

messageMetadata

QueueConversationVideoEventTopicMessageMetadata messageMetadata

messageSegmentCount

Integer messageSegmentCount

messageStatus

QueueConversationVideoEventTopicMessageDetails.MessageStatusEnum messageStatus

messageTime

Date messageTime

stickers

List<QueueConversationVideoEventTopicMessageSticker> stickers

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicMessageMedia

class QueueConversationVideoEventTopicMessageMedia extends Object implements Serializable

Serialized Fields

contentLengthBytes

Integer contentLengthBytes

id

String id

mediaType

String mediaType

name

String name

url

String url

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicMessageMetadata

class QueueConversationVideoEventTopicMessageMetadata extends Object implements Serializable

Serialized Fields

content

List<QueueConversationVideoEventTopicMessageMetadataContent> content

events

List<QueueConversationVideoEventTopicMessageMetadataEvent> events

type

String type

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicMessageMetadataContent

class QueueConversationVideoEventTopicMessageMetadataContent extends Object implements Serializable

Serialized Fields

contentType

String contentType

subType

String subType

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicMessageMetadataEvent

class QueueConversationVideoEventTopicMessageMetadataEvent extends Object implements Serializable

Serialized Fields

eventType

String eventType

subType

String subType

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicMessageSticker

class QueueConversationVideoEventTopicMessageSticker extends Object implements Serializable

Serialized Fields

id

String id

url

String url

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicModifiedBy

class QueueConversationVideoEventTopicModifiedBy extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicObject

class QueueConversationVideoEventTopicObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicParticipant

class QueueConversationVideoEventTopicParticipant extends Object implements Serializable

Serialized Fields

address

String address

alertingTimeoutMs

Integer alertingTimeoutMs

attributes

Map<String,String> attributes

bargedParticipantId

String bargedParticipantId

callbacks

List<QueueConversationVideoEventTopicCallback> callbacks

calls

List<QueueConversationVideoEventTopicCall> calls

chats

List<QueueConversationVideoEventTopicChat> chats

coachedParticipantId

String coachedParticipantId

cobrowsesessions

List<QueueConversationVideoEventTopicCobrowse> cobrowsesessions

connectedTime

Date connectedTime

consultParticipantId

String consultParticipantId

conversationRoutingData

QueueConversationVideoEventTopicConversationRoutingData conversationRoutingData

emails

List<QueueConversationVideoEventTopicEmail> emails

endAcwTime

Date endAcwTime

endTime

Date endTime

externalContactId

String externalContactId

externalOrganizationId

String externalOrganizationId

flaggedReason

String flaggedReason

groupId

String groupId

id

String id

mediaRoles

List<String> mediaRoles

messages

List<QueueConversationVideoEventTopicMessage> messages

monitoredParticipantId

String monitoredParticipantId

name

String name

purpose

String purpose

queueId

String queueId

screenRecordingState

QueueConversationVideoEventTopicParticipant.ScreenRecordingStateEnum screenRecordingState

screenshares

List<QueueConversationVideoEventTopicScreenshare> screenshares

socialExpressions

List<QueueConversationVideoEventTopicSocialExpression> socialExpressions

startAcwTime

Date startAcwTime

teamId

String teamId

userId

String userId

videos

List<QueueConversationVideoEventTopicVideo> videos

workflow

QueueConversationVideoEventTopicWorkflow workflow

wrapup

QueueConversationVideoEventTopicWrapup wrapup

wrapupExpected

Boolean wrapupExpected

wrapupPrompt

String wrapupPrompt

wrapupRequired

Boolean wrapupRequired

wrapupTimeoutMs

Integer wrapupTimeoutMs

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicPhoneNumberColumn

class QueueConversationVideoEventTopicPhoneNumberColumn extends Object implements Serializable

Serialized Fields

columnName

String columnName

type

String type

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicRecentTransfer

class QueueConversationVideoEventTopicRecentTransfer extends Object implements Serializable

Serialized Fields

dateIssued

Date dateIssued

destination

QueueConversationVideoEventTopicDestination destination

id

String id

initiator

QueueConversationVideoEventTopicInitiator initiator

modifiedBy

QueueConversationVideoEventTopicModifiedBy modifiedBy

state

QueueConversationVideoEventTopicRecentTransfer.StateEnum state

transferType

QueueConversationVideoEventTopicRecentTransfer.TransferTypeEnum transferType

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicScoredAgent

class QueueConversationVideoEventTopicScoredAgent extends Object implements Serializable

Serialized Fields

agent

QueueConversationVideoEventTopicUriReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicScreenshare

class QueueConversationVideoEventTopicScreenshare extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationVideoEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

connectedTime

Date connectedTime

context

String context

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationVideoEventTopicScreenshare.DisconnectTypeEnum disconnectType

id

String id

initialState

QueueConversationVideoEventTopicScreenshare.InitialStateEnum initialState

peerCount

Object peerCount

peerId

String peerId

provider

String provider

scriptId

String scriptId

self

QueueConversationVideoEventTopicAddress self

sharing

Boolean sharing

state

QueueConversationVideoEventTopicScreenshare.StateEnum state

wrapup

QueueConversationVideoEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicSocialExpression

class QueueConversationVideoEventTopicSocialExpression extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationVideoEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

connectedTime

Date connectedTime

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationVideoEventTopicSocialExpression.DisconnectTypeEnum disconnectType

held

Boolean held

id

String id

initialState

QueueConversationVideoEventTopicSocialExpression.InitialStateEnum initialState

peerId

String peerId

previewText

String previewText

provider

String provider

recordingId

String recordingId

scriptId

String scriptId

socialMediaHub

String socialMediaHub

socialMediaId

String socialMediaId

socialUserName

String socialUserName

startHoldTime

Date startHoldTime

state

QueueConversationVideoEventTopicSocialExpression.StateEnum state

wrapup

QueueConversationVideoEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicUriReference

class QueueConversationVideoEventTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicVideo

class QueueConversationVideoEventTopicVideo extends Object implements Serializable

Serialized Fields

afterCallWork

QueueConversationVideoEventTopicAfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

audioMuted

Boolean audioMuted

connectedTime

Date connectedTime

context

String context

disconnectedTime

Date disconnectedTime

disconnectType

QueueConversationVideoEventTopicVideo.DisconnectTypeEnum disconnectType

id

String id

initialState

QueueConversationVideoEventTopicVideo.InitialStateEnum initialState

msids

List<String> msids

peerCount

Object peerCount

peerId

String peerId

provider

String provider

scriptId

String scriptId

self

QueueConversationVideoEventTopicAddress self

sharingScreen

Boolean sharingScreen

state

QueueConversationVideoEventTopicVideo.StateEnum state

videoMuted

Boolean videoMuted

wrapup

QueueConversationVideoEventTopicWrapup wrapup

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicVoicemail

class QueueConversationVideoEventTopicVoicemail extends Object implements Serializable

Serialized Fields

id

String id

uploadStatus

QueueConversationVideoEventTopicVoicemail.UploadStatusEnum uploadStatus

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicWorkflow

class QueueConversationVideoEventTopicWorkflow extends Object implements Serializable

Serialized Fields

workflowId

String workflowId

Class com.mypurecloud.sdk.v2.model.QueueConversationVideoEventTopicWrapup

class QueueConversationVideoEventTopicWrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

notes

String notes

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.QueueEmailAddress

class QueueEmailAddress extends Object implements Serializable

Serialized Fields

domain

DomainEntityRef domain

route

InboundRoute route

Class com.mypurecloud.sdk.v2.model.QueueEntityListing

class QueueEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Queue> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.QueueMediaSettings

class QueueMediaSettings extends Object implements Serializable

Serialized Fields

call

MediaSettings call

callback

CallbackMediaSettings callback

chat

MediaSettings chat

email

MediaSettings email

message

MediaSettings message

Class com.mypurecloud.sdk.v2.model.QueueMember

class QueueMember extends Object implements Serializable

Serialized Fields

id

String id

joined

Boolean joined

memberBy

String memberBy

name

String name

ringNumber

Integer ringNumber

routingStatus

RoutingStatus routingStatus

selfUri

String selfUri

user

User user

Class com.mypurecloud.sdk.v2.model.QueueMemberEntityListing

class QueueMemberEntityListing extends Object implements Serializable

Serialized Fields

entities

List<QueueMember> entities

firstUri

String firstUri

nextUri

String nextUri

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.QueueMemberEntityListingV1

class QueueMemberEntityListingV1 extends Object implements Serializable

Serialized Fields

entities

List<QueueMember> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.QueueMessagingAddresses

class QueueMessagingAddresses extends Object implements Serializable

Serialized Fields

openMessagingRecipient

DomainEntityRef openMessagingRecipient

smsAddress

DomainEntityRef smsAddress

Class com.mypurecloud.sdk.v2.model.QueueObservationDataContainer

class QueueObservationDataContainer extends Object implements Serializable

Serialized Fields

data

List<ObservationMetricData> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.QueueObservationQuery

class QueueObservationQuery extends Object implements Serializable

Serialized Fields

detailMetrics

List<QueueObservationQuery.DetailMetricsEnum> detailMetrics

filter

QueueObservationQueryFilter filter

metrics

List<QueueObservationQuery.MetricsEnum> metrics

Class com.mypurecloud.sdk.v2.model.QueueObservationQueryClause

class QueueObservationQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<QueueObservationQueryPredicate> predicates

type

QueueObservationQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.QueueObservationQueryFilter

class QueueObservationQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<QueueObservationQueryClause> clauses

predicates

List<QueueObservationQueryPredicate> predicates

type

QueueObservationQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.QueueObservationQueryPredicate

class QueueObservationQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

QueueObservationQueryPredicate.DimensionEnum dimension

operator

QueueObservationQueryPredicate.OperatorEnum operator

range

NumericRange range

type

QueueObservationQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.QueueObservationQueryResponse

class QueueObservationQueryResponse extends Object implements Serializable

Serialized Fields

results

List<QueueObservationDataContainer> results

systemToOrganizationMappings

Map<String,List<String>> systemToOrganizationMappings

Class com.mypurecloud.sdk.v2.model.QueueReference

class QueueReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.QueueRequest

class QueueRequest extends Object implements Serializable

Serialized Fields

acwSettings

AcwSettings acwSettings

agentOwnedRouting

AgentOwnedRouting agentOwnedRouting

autoAnswerOnly

Boolean autoAnswerOnly

bullseye

Bullseye bullseye

callingPartyName

String callingPartyName

callingPartyNumber

String callingPartyNumber

createdBy

String createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

defaultScripts

Map<String,Script> defaultScripts

description

String description

directRouting

DirectRouting directRouting

division

WritableDivision division

emailInQueueFlow

DomainEntityRef emailInQueueFlow

enableManualAssignment

Boolean enableManualAssignment

enableTranscription

Boolean enableTranscription

id

String id

joinedMemberCount

Integer joinedMemberCount

mediaSettings

QueueMediaSettings mediaSettings

memberCount

Integer memberCount

memberGroups

List<MemberGroup> memberGroups

messageInQueueFlow

DomainEntityRef messageInQueueFlow

modifiedBy

String modifiedBy

name

String name

onHoldPrompt

DomainEntityRef onHoldPrompt

outboundEmailAddress

QueueEmailAddress outboundEmailAddress

outboundMessagingAddresses

QueueMessagingAddresses outboundMessagingAddresses

peerId

String peerId

queueFlow

DomainEntityRef queueFlow

routingRules

List<RoutingRule> routingRules

selfUri

String selfUri

skillEvaluationMethod

QueueRequest.SkillEvaluationMethodEnum skillEvaluationMethod

userMemberCount

Integer userMemberCount

whisperPrompt

DomainEntityRef whisperPrompt

Class com.mypurecloud.sdk.v2.model.QueueUserEventTopicObject

class QueueUserEventTopicObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.QueueUserEventTopicQueueMember

class QueueUserEventTopicQueueMember extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

id

String id

joined

Boolean joined

queueId

String queueId

user

QueueUserEventTopicUserReference user

Class com.mypurecloud.sdk.v2.model.QueueUserEventTopicUserReference

class QueueUserEventTopicUserReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.QueueUtilizationDiagnostic

class QueueUtilizationDiagnostic extends Object implements Serializable

Serialized Fields

activeUsersInQueue

Integer activeUsersInQueue

queue

DomainEntityRef queue

usersInQueue

Integer usersInQueue

usersNotUtilized

Integer usersNotUtilized

usersOnACampaignCall

Integer usersOnACampaignCall

usersOnANonCampaignCall

Integer usersOnANonCampaignCall

usersOnDifferentEdgeGroup

Integer usersOnDifferentEdgeGroup

usersOnQueue

Integer usersOnQueue

usersOnQueueWithStation

Integer usersOnQueueWithStation

Class com.mypurecloud.sdk.v2.model.QuickReply

class QuickReply extends Object implements Serializable

Serialized Fields

action

QuickReply.ActionEnum action

isSelected

Boolean isSelected

payload

String payload

text

String text

url

String url

Class com.mypurecloud.sdk.v2.model.Reaction

class Reaction extends Object implements Serializable

Serialized Fields

data

String data

name

String name

reactionType

Reaction.ReactionTypeEnum reactionType

Class com.mypurecloud.sdk.v2.model.RealTimeAdherenceExplanation

class RealTimeAdherenceExplanation extends Object implements Serializable

Serialized Fields

id

String id

lengthMinutes

Integer lengthMinutes

selfUri

String selfUri

startDate

Date startDate

status

RealTimeAdherenceExplanation.StatusEnum status

Class com.mypurecloud.sdk.v2.model.RecallEntry

class RecallEntry extends Object implements Serializable

Serialized Fields

minutesBetweenAttempts

Integer minutesBetweenAttempts

nbrAttempts

Integer nbrAttempts

Class com.mypurecloud.sdk.v2.model.Recipient

class Recipient extends Object implements Serializable

Serialized Fields

createdBy

User createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

flow

Flow flow

id

String id

messengerType

Recipient.MessengerTypeEnum messengerType

modifiedBy

User modifiedBy

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.RecipientAdditionalIdentifier

class RecipientAdditionalIdentifier extends Object implements Serializable

Serialized Fields

type

RecipientAdditionalIdentifier.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.RecipientListing

class RecipientListing extends Object implements Serializable

Serialized Fields

entities

List<Recipient> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.Record

class Record extends Object implements Serializable

Serialized Fields

name

String name

type

String type

value

String value

Class com.mypurecloud.sdk.v2.model.Recording

class Recording extends Object implements Serializable

Serialized Fields

actualTranscodeTimeMs

Long actualTranscodeTimeMs

annotations

List<Annotation> annotations

archiveDate

Date archiveDate

archiveMedium

Recording.ArchiveMediumEnum archiveMedium

conversationId

String conversationId

creationTime

Date creationTime

deleteDate

Date deleteDate

emailTranscript

List<RecordingEmailMessage> emailTranscript

endTime

String endTime

estimatedTranscodeTimeMs

Long estimatedTranscodeTimeMs

exportDate

Date exportDate

exportedDate

Date exportedDate

fileState

Recording.FileStateEnum fileState

id

String id

maxAllowedRestorationsForOrg

Integer maxAllowedRestorationsForOrg

media

String media

mediaUris

Map<String,MediaResult> mediaUris

messagingTranscript

List<RecordingMessagingMessage> messagingTranscript

name

String name

originalRecordingStartTime

Date originalRecordingStartTime

outputDurationMs

Integer outputDurationMs

outputSizeInBytes

Integer outputSizeInBytes

path

String path

recordingErrorStatus

Recording.RecordingErrorStatusEnum recordingErrorStatus

recordingFileRole

Recording.RecordingFileRoleEnum recordingFileRole

remainingRestorationsAllowedForOrg

Integer remainingRestorationsAllowedForOrg

restoreExpirationTime

Date restoreExpirationTime

selfUri

String selfUri

sessionId

String sessionId

startTime

String startTime

transcript

List<ChatMessage> transcript

users

List<User> users

Class com.mypurecloud.sdk.v2.model.RecordingAnnotationFlow

class RecordingAnnotationFlow extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.RecordingAnnotationQueue

class RecordingAnnotationQueue extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.RecordingArchiveRestoreTopicMediaResult

class RecordingArchiveRestoreTopicMediaResult extends Object implements Serializable

Serialized Fields

channelId

String channelId

mediaUri

String mediaUri

waveformData

List<BigDecimal> waveformData

waveUri

String waveUri

Class com.mypurecloud.sdk.v2.model.RecordingArchiveRestoreTopicRecording

class RecordingArchiveRestoreTopicRecording extends Object implements Serializable

Serialized Fields

actualTranscodeTimeMs

Integer actualTranscodeTimeMs

conversationId

String conversationId

estimatedTranscodeTimeMs

Integer estimatedTranscodeTimeMs

fileState

String fileState

id

String id

mediaUris

List<RecordingArchiveRestoreTopicMediaResult> mediaUris

Class com.mypurecloud.sdk.v2.model.RecordingButtonComponent

class RecordingButtonComponent extends Object implements Serializable

Serialized Fields

actions

RecordingContentActions actions

isSelected

Boolean isSelected

title

String title

Class com.mypurecloud.sdk.v2.model.RecordingContentActions

class RecordingContentActions extends Object implements Serializable

Serialized Fields

textback

String textback

url

String url

urlTarget

String urlTarget

Class com.mypurecloud.sdk.v2.model.RecordingContentStory

class RecordingContentStory extends Object implements Serializable

Serialized Fields

replyToId

String replyToId

type

RecordingContentStory.TypeEnum type

url

String url

Class com.mypurecloud.sdk.v2.model.RecordingEmailMessage

class RecordingEmailMessage extends Object implements Serializable

Serialized Fields

attachments

List<EmailAttachment> attachments

bcc

List<EmailAddress> bcc

cc

List<EmailAddress> cc

from

EmailAddress from

htmlBody

String htmlBody

id

String id

subject

String subject

textBody

String textBody

time

Date time

to

List<EmailAddress> to

Class com.mypurecloud.sdk.v2.model.RecordingEncryptionConfiguration

class RecordingEncryptionConfiguration extends Object implements Serializable

Serialized Fields

apiId

String apiId

apiKey

String apiKey

id

String id

keyConfigurationType

RecordingEncryptionConfiguration.KeyConfigurationTypeEnum keyConfigurationType

lastError

ErrorBody lastError

selfUri

String selfUri

url

String url

Class com.mypurecloud.sdk.v2.model.RecordingEncryptionConfigurationListing

class RecordingEncryptionConfigurationListing extends Object implements Serializable

Serialized Fields

entities

List<RecordingEncryptionConfiguration> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.RecordingEventMediaResult

class RecordingEventMediaResult extends Object implements Serializable

Serialized Fields

channelId

String channelId

mediaUri

String mediaUri

waveformData

List<BigDecimal> waveformData

waveUri

String waveUri

Class com.mypurecloud.sdk.v2.model.RecordingEventRecording

class RecordingEventRecording extends Object implements Serializable

Serialized Fields

actualTranscodeTimeMs

Integer actualTranscodeTimeMs

conversationId

String conversationId

estimatedTranscodeTimeMs

Integer estimatedTranscodeTimeMs

fileState

String fileState

id

String id

mediaUris

List<RecordingEventMediaResult> mediaUris

Class com.mypurecloud.sdk.v2.model.RecordingJob

class RecordingJob extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

errorMessage

String errorMessage

failedRecordings

String failedRecordings

id

String id

percentProgress

Integer percentProgress

recordingJobsQuery

RecordingJobsQuery recordingJobsQuery

selfUri

String selfUri

state

RecordingJob.StateEnum state

totalConversations

Integer totalConversations

totalFailedRecordings

Integer totalFailedRecordings

totalProcessedRecordings

Integer totalProcessedRecordings

totalRecordings

Integer totalRecordings

totalSkippedRecordings

Integer totalSkippedRecordings

user

AddressableEntityRef user

Class com.mypurecloud.sdk.v2.model.RecordingJobEntityListing

class RecordingJobEntityListing extends Object implements Serializable

Serialized Fields

entities

List<RecordingJob> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.RecordingJobFailedRecording

class RecordingJobFailedRecording extends Object implements Serializable

Serialized Fields

conversation

AddressableEntityRef conversation

recording

AddressableEntityRef recording

Class com.mypurecloud.sdk.v2.model.RecordingJobsQuery

class RecordingJobsQuery extends Object implements Serializable

Serialized Fields

action

RecordingJobsQuery.ActionEnum action

actionAge

Integer actionAge

actionDate

Date actionDate

clearExport

Boolean clearExport

conversationQuery

AsyncConversationQuery conversationQuery

includeRecordingsWithSensitiveData

Boolean includeRecordingsWithSensitiveData

includeScreenRecordings

Boolean includeScreenRecordings

integrationId

String integrationId

screenRecordingActionAge

Integer screenRecordingActionAge

screenRecordingActionDate

Date screenRecordingActionDate

Class com.mypurecloud.sdk.v2.model.RecordingMessagingMessage

class RecordingMessagingMessage extends Object implements Serializable

Serialized Fields

buttonResponse

ButtonResponse buttonResponse

from

String from

fromExternalContact

ExternalContact fromExternalContact

fromUser

User fromUser

id

String id

messageMediaAttachments

List<MessageMediaAttachment> messageMediaAttachments

messageStickerAttachments

List<MessageStickerAttachment> messageStickerAttachments

messageText

String messageText

quickReplies

List<QuickReply> quickReplies

story

RecordingContentStory story

timestamp

Date timestamp

to

String to

Class com.mypurecloud.sdk.v2.model.RecordingMetadata

class RecordingMetadata extends Object implements Serializable

Serialized Fields

annotations

List<Annotation> annotations

archiveDate

Date archiveDate

archiveMedium

RecordingMetadata.ArchiveMediumEnum archiveMedium

conversationId

String conversationId

deleteDate

Date deleteDate

endTime

String endTime

exportDate

Date exportDate

exportedDate

Date exportedDate

fileState

RecordingMetadata.FileStateEnum fileState

id

String id

maxAllowedRestorationsForOrg

Integer maxAllowedRestorationsForOrg

media

String media

name

String name

path

String path

remainingRestorationsAllowedForOrg

Integer remainingRestorationsAllowedForOrg

restoreExpirationTime

Date restoreExpirationTime

selfUri

String selfUri

sessionId

String sessionId

startTime

String startTime

Class com.mypurecloud.sdk.v2.model.RecordingRetention

class RecordingRetention extends Object implements Serializable

Serialized Fields

archiveDate

Date archiveDate

archiveMedium

RecordingRetention.ArchiveMediumEnum archiveMedium

conversationId

String conversationId

creationTime

Date creationTime

deleteDate

Date deleteDate

exportDate

Date exportDate

exportedDate

Date exportedDate

recordingId

String recordingId

Class com.mypurecloud.sdk.v2.model.RecordingRetentionCursorEntityListing

class RecordingRetentionCursorEntityListing extends Object implements Serializable

Serialized Fields

entities

List<RecordingRetention> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.RecordingSettings

class RecordingSettings extends Object implements Serializable

Serialized Fields

maxConfigurableScreenRecordingStreams

Integer maxConfigurableScreenRecordingStreams

maxSimultaneousStreams

Integer maxSimultaneousStreams

regionalRecordingStorageEnabled

Boolean regionalRecordingStorageEnabled

Class com.mypurecloud.sdk.v2.model.RecordingTranscodeCompleteTopicMediaResult

class RecordingTranscodeCompleteTopicMediaResult extends Object implements Serializable

Serialized Fields

channelId

String channelId

mediaUri

String mediaUri

waveformData

List<BigDecimal> waveformData

waveUri

String waveUri

Class com.mypurecloud.sdk.v2.model.RecordingTranscodeCompleteTopicRecording

class RecordingTranscodeCompleteTopicRecording extends Object implements Serializable

Serialized Fields

actualTranscodeTimeMs

Integer actualTranscodeTimeMs

conversationId

String conversationId

estimatedTranscodeTimeMs

Integer estimatedTranscodeTimeMs

fileState

String fileState

id

String id

mediaUris

List<RecordingTranscodeCompleteTopicMediaResult> mediaUris

Class com.mypurecloud.sdk.v2.model.RecordingUploadReport

class RecordingUploadReport extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

signedUrl

String signedUrl

state

RecordingUploadReport.StateEnum state

Class com.mypurecloud.sdk.v2.model.RecordingUploadReportRequest

class RecordingUploadReportRequest extends Object implements Serializable

Serialized Fields

dateSince

Date dateSince

uploadStatus

RecordingUploadReportRequest.UploadStatusEnum uploadStatus

Class com.mypurecloud.sdk.v2.model.Referrer

class Referrer extends Object implements Serializable

Serialized Fields

domain

String domain

fragment

String fragment

hostname

String hostname

keywords

String keywords

medium

Referrer.MediumEnum medium

name

String name

pathname

String pathname

queryString

String queryString

url

String url

Class com.mypurecloud.sdk.v2.model.RegionTimeZone

class RegionTimeZone extends Object implements Serializable

Serialized Fields

id

String id

name

String name

offset

Long offset

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.RegisterArchitectJobResponse

class RegisterArchitectJobResponse extends Object implements Serializable

Serialized Fields

headers

Map<String,String> headers

id

String id

presignedUrl

String presignedUrl

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.Relationship

class Relationship extends Object implements Serializable

Serialized Fields

externalDataSources

List<ExternalDataSource> externalDataSources

externalOrganization

ExternalOrganization externalOrganization

id

String id

relationship

String relationship

selfUri

String selfUri

user

User user

Class com.mypurecloud.sdk.v2.model.RelationshipListing

class RelationshipListing extends Object implements Serializable

Serialized Fields

entities

List<Relationship> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

partialResults

Boolean partialResults

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ReplacementTerm

class ReplacementTerm extends Object implements Serializable

Serialized Fields

existingValue

String existingValue

type

ReplacementTerm.TypeEnum type

updatedValue

String updatedValue

Class com.mypurecloud.sdk.v2.model.ReplaceRequest

class ReplaceRequest extends Object implements Serializable

Serialized Fields

authToken

String authToken

changeNumber

Integer changeNumber

name

String name

Class com.mypurecloud.sdk.v2.model.ReplaceResponse

class ReplaceResponse extends Object implements Serializable

Serialized Fields

changeNumber

Integer changeNumber

id

String id

name

String name

uploadDestinationUri

String uploadDestinationUri

uploadMethod

ReplaceResponse.UploadMethodEnum uploadMethod

uploadStatus

DomainEntityRef uploadStatus

Class com.mypurecloud.sdk.v2.model.ReplyToEmailAddress

class ReplyToEmailAddress extends Object implements Serializable

Serialized Fields

domain

DomainEntityRef domain

route

DomainEntityRef route

Class com.mypurecloud.sdk.v2.model.ReportingDataExportTopicDataExportNotification

class ReportingDataExportTopicDataExportNotification extends Object implements Serializable

Serialized Fields

createdDateTime

Date createdDateTime

downloadUrl

String downloadUrl

emailErrorDescription

String emailErrorDescription

emailStatuses

Map<String,ReportingDataExportTopicDataExportNotification.InnerEnum> emailStatuses

exportAllowedToRerun

Boolean exportAllowedToRerun

exportErrorMessagesType

ReportingDataExportTopicDataExportNotification.ExportErrorMessagesTypeEnum exportErrorMessagesType

exportFormat

ReportingDataExportTopicDataExportNotification.ExportFormatEnum exportFormat

id

String id

modifiedDateTime

Date modifiedDateTime

name

String name

percentageComplete

BigDecimal percentageComplete

read

Boolean read

runId

String runId

scheduleExpression

String scheduleExpression

scheduleStaticLinkUrl

String scheduleStaticLinkUrl

status

ReportingDataExportTopicDataExportNotification.StatusEnum status

viewType

ReportingDataExportTopicDataExportNotification.ViewTypeEnum viewType

Class com.mypurecloud.sdk.v2.model.ReportingExportJobListing

class ReportingExportJobListing extends Object implements Serializable

Serialized Fields

entities

List<ReportingExportJobResponse> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ReportingExportJobRequest

class ReportingExportJobRequest extends Object implements Serializable

Serialized Fields

csvDelimiter

ReportingExportJobRequest.CsvDelimiterEnum csvDelimiter

durationFormat

ReportingExportJobRequest.DurationFormatEnum durationFormat

excludeEmptyRows

Boolean excludeEmptyRows

exportFormat

ReportingExportJobRequest.ExportFormatEnum exportFormat

filter

ViewFilter filter

hasCustomParticipantAttributes

Boolean hasCustomParticipantAttributes

hasFormatDurations

Boolean hasFormatDurations

hasSplitByMedia

Boolean hasSplitByMedia

hasSplitFilters

Boolean hasSplitFilters

hasSummaryRow

Boolean hasSummaryRow

includeDurationFormatInHeader

Boolean includeDurationFormatInHeader

interval

String interval

locale

String locale

name

String name

period

String period

read

Boolean read

recipientEmails

List<String> recipientEmails

selectedColumns

List<SelectedColumns> selectedColumns

timeZone

String timeZone

viewType

ReportingExportJobRequest.ViewTypeEnum viewType

Class com.mypurecloud.sdk.v2.model.ReportingExportJobResponse

class ReportingExportJobResponse extends Object implements Serializable

Serialized Fields

createdDateTime

Date createdDateTime

csvDelimiter

ReportingExportJobResponse.CsvDelimiterEnum csvDelimiter

downloadUrl

String downloadUrl

durationFormat

ReportingExportJobResponse.DurationFormatEnum durationFormat

emailErrorDescription

String emailErrorDescription

emailStatuses

Map<String,ReportingExportJobResponse.InnerEnum> emailStatuses

enabled

Boolean enabled

excludeEmptyRows

Boolean excludeEmptyRows

exportErrorMessagesType

ReportingExportJobResponse.ExportErrorMessagesTypeEnum exportErrorMessagesType

exportFormat

ReportingExportJobResponse.ExportFormatEnum exportFormat

filter

ViewFilter filter

hasCustomParticipantAttributes

Boolean hasCustomParticipantAttributes

hasFormatDurations

Boolean hasFormatDurations

hasSplitByMedia

Boolean hasSplitByMedia

hasSplitFilters

Boolean hasSplitFilters

hasSummaryRow

Boolean hasSummaryRow

id

String id

includeDurationFormatInHeader

Boolean includeDurationFormatInHeader

interval

String interval

locale

String locale

modifiedDateTime

Date modifiedDateTime

name

String name

percentageComplete

Double percentageComplete

period

String period

read

Boolean read

recipientEmails

List<String> recipientEmails

runId

String runId

selectedColumns

List<SelectedColumns> selectedColumns

selfUri

String selfUri

status

ReportingExportJobResponse.StatusEnum status

timeZone

String timeZone

viewType

ReportingExportJobResponse.ViewTypeEnum viewType

Class com.mypurecloud.sdk.v2.model.ReportingExportMetadataJobListing

class ReportingExportMetadataJobListing extends Object implements Serializable

Serialized Fields

entities

List<ReportingExportMetadataJobResponse> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ReportingExportMetadataJobResponse

class ReportingExportMetadataJobResponse extends Object implements Serializable

Serialized Fields

availableColumnIds

List<String> availableColumnIds

dateLimitations

String dateLimitations

dependentColumnIds

Map<String,List<String>> dependentColumnIds

id

String id

name

String name

requiredColumnIds

List<String> requiredColumnIds

requiredFilters

List<String> requiredFilters

selfUri

String selfUri

supportedFilters

List<String> supportedFilters

viewType

ReportingExportMetadataJobResponse.ViewTypeEnum viewType

Class com.mypurecloud.sdk.v2.model.ReportingInterval

class ReportingInterval extends Object implements Serializable

Serialized Fields

intervalType

ReportingInterval.IntervalTypeEnum intervalType

intervalValue

Integer intervalValue

Class com.mypurecloud.sdk.v2.model.ReportingTurn

class ReportingTurn extends Object implements Serializable

Serialized Fields

askAction

ReportingTurnAction askAction

askActionResult

ReportingTurn.AskActionResultEnum askActionResult

botPrompts

List<String> botPrompts

conversation

AddressableEntityRef conversation

dateCreated

Date dateCreated

intent

ReportingTurnIntent intent

knowledge

ReportingTurnKnowledge knowledge

sessionEndDetails

SessionEndDetails sessionEndDetails

sessionId

String sessionId

userInput

String userInput

Class com.mypurecloud.sdk.v2.model.ReportingTurnAction

class ReportingTurnAction extends Object implements Serializable

Serialized Fields

actionId

String actionId

actionName

String actionName

actionNumber

Integer actionNumber

actionType

ReportingTurnAction.ActionTypeEnum actionType

Class com.mypurecloud.sdk.v2.model.ReportingTurnIntent

class ReportingTurnIntent extends Object implements Serializable

Serialized Fields

confidence

Double confidence

name

String name

slots

List<ReportingTurnIntentSlot> slots

Class com.mypurecloud.sdk.v2.model.ReportingTurnIntentSlot

class ReportingTurnIntentSlot extends Object implements Serializable

Serialized Fields

confidence

Double confidence

name

String name

type

String type

value

String value

Class com.mypurecloud.sdk.v2.model.ReportingTurnKnowledge

class ReportingTurnKnowledge extends Object implements Serializable

Serialized Fields

feedback

ReportingTurnKnowledgeFeedback feedback

knowledgeBaseId

String knowledgeBaseId

search

ReportingTurnKnowledgeSearch search

Class com.mypurecloud.sdk.v2.model.ReportingTurnKnowledgeDocument

class ReportingTurnKnowledgeDocument extends Object implements Serializable

Serialized Fields

answer

String answer

confidence

Double confidence

id

String id

question

String question

Class com.mypurecloud.sdk.v2.model.ReportingTurnKnowledgeFeedback

class ReportingTurnKnowledgeFeedback extends Object implements Serializable

Serialized Fields

documents

List<ReportingTurnKnowledgeDocument> documents

rating

Integer rating

searchId

String searchId

Class com.mypurecloud.sdk.v2.model.ReportingTurnKnowledgeSearch

class ReportingTurnKnowledgeSearch extends Object implements Serializable

Serialized Fields

documents

List<ReportingTurnKnowledgeDocument> documents

query

String query

searchId

String searchId

Class com.mypurecloud.sdk.v2.model.ReportingTurnsResponse

class ReportingTurnsResponse extends Object implements Serializable

Serialized Fields

entities

List<ReportingTurn> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ReportMetaData

class ReportMetaData extends Object implements Serializable

Serialized Fields

availableLocales

List<String> availableLocales

description

String description

exampleUrl

String exampleUrl

id

String id

keywords

List<String> keywords

name

String name

parameters

List<Parameter> parameters

selfUri

String selfUri

title

String title

Class com.mypurecloud.sdk.v2.model.ReportMetaDataEntityListing

class ReportMetaDataEntityListing extends Object implements Serializable

Serialized Fields

entities

List<ReportMetaData> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ReportRunEntry

class ReportRunEntry extends Object implements Serializable

Serialized Fields

errorMessage

String errorMessage

id

String id

name

String name

reportFormat

String reportFormat

reportId

String reportId

reportUrl

String reportUrl

runDurationMsec

Long runDurationMsec

runStatus

ReportRunEntry.RunStatusEnum runStatus

runTime

Date runTime

scheduleUri

String scheduleUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ReportRunEntryEntityDomainListing

class ReportRunEntryEntityDomainListing extends Object implements Serializable

Serialized Fields

entities

List<ReportRunEntry> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ReportSchedule

class ReportSchedule extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

enabled

Boolean enabled

id

String id

interval

String interval

lastRun

ReportRunEntry lastRun

locale

String locale

name

String name

nextFireTime

Date nextFireTime

parameters

Map<String,Object> parameters

quartzCronExpression

String quartzCronExpression

reportFormat

String reportFormat

reportId

String reportId

selfUri

String selfUri

timePeriod

String timePeriod

timeZone

String timeZone

Class com.mypurecloud.sdk.v2.model.ReportScheduleEntityListing

class ReportScheduleEntityListing extends Object implements Serializable

Serialized Fields

entities

List<ReportSchedule> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.RequestConfig

class RequestConfig extends Object implements Serializable

Serialized Fields

headers

Map<String,String> headers

requestTemplate

String requestTemplate

requestTemplateUri

String requestTemplateUri

requestType

String requestType

requestUrlTemplate

String requestUrlTemplate

Class com.mypurecloud.sdk.v2.model.RequestMapping

class RequestMapping extends Object implements Serializable

Serialized Fields

attributeType

RequestMapping.AttributeTypeEnum attributeType

mappingType

RequestMapping.MappingTypeEnum mappingType

name

String name

value

String value

Class com.mypurecloud.sdk.v2.model.RequestScoredAgent

class RequestScoredAgent extends Object implements Serializable

Serialized Fields

id

String id

score

Integer score

Class com.mypurecloud.sdk.v2.model.ReschedulingManagementUnitResponse

class ReschedulingManagementUnitResponse extends Object implements Serializable

Serialized Fields

applied

Boolean applied

managementUnit

ManagementUnitReference managementUnit

Class com.mypurecloud.sdk.v2.model.ReschedulingOptionsRunResponse

class ReschedulingOptionsRunResponse extends Object implements Serializable

Serialized Fields

activityCodeIds

List<String> activityCodeIds

agentCount

Integer agentCount

doNotChangeDailyPaidTime

Boolean doNotChangeDailyPaidTime

doNotChangeManuallyEditedShifts

Boolean doNotChangeManuallyEditedShifts

doNotChangeShiftStartTimes

Boolean doNotChangeShiftStartTimes

doNotChangeWeeklyPaidTime

Boolean doNotChangeWeeklyPaidTime

endDate

Date endDate

existingSchedule

BuScheduleReference existingSchedule

managementUnits

List<ReschedulingManagementUnitResponse> managementUnits

startDate

Date startDate

Class com.mypurecloud.sdk.v2.model.ResolutionAggregateDataContainer

class ResolutionAggregateDataContainer extends Object implements Serializable

Serialized Fields

data

List<StatisticalResponse> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.ResolutionAggregateQueryClause

class ResolutionAggregateQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<ResolutionAggregateQueryPredicate> predicates

type

ResolutionAggregateQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ResolutionAggregateQueryFilter

class ResolutionAggregateQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<ResolutionAggregateQueryClause> clauses

predicates

List<ResolutionAggregateQueryPredicate> predicates

type

ResolutionAggregateQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ResolutionAggregateQueryPredicate

class ResolutionAggregateQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

ResolutionAggregateQueryPredicate.DimensionEnum dimension

operator

ResolutionAggregateQueryPredicate.OperatorEnum operator

range

NumericRange range

type

ResolutionAggregateQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.ResolutionAggregationView

class ResolutionAggregationView extends Object implements Serializable

Serialized Fields

function

ResolutionAggregationView.FunctionEnum function

name

String name

range

AggregationRange range

target

ResolutionAggregationView.TargetEnum target

Class com.mypurecloud.sdk.v2.model.ResolutionAsyncAggregateQueryResponse

class ResolutionAsyncAggregateQueryResponse extends Object implements Serializable

Serialized Fields

cursor

String cursor

results

List<ResolutionAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.ResolutionAsyncAggregationQuery

class ResolutionAsyncAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

ResolutionAsyncAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

ResolutionAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<ResolutionAsyncAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<ResolutionAsyncAggregationQuery.MetricsEnum> metrics

pageSize

Integer pageSize

timeZone

String timeZone

views

List<ResolutionAggregationView> views

Class com.mypurecloud.sdk.v2.model.ResolutionDetailQueryClause

class ResolutionDetailQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<ResolutionDetailQueryPredicate> predicates

type

ResolutionDetailQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ResolutionDetailQueryFilter

class ResolutionDetailQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<ResolutionDetailQueryClause> clauses

predicates

List<ResolutionDetailQueryPredicate> predicates

type

ResolutionDetailQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ResolutionDetailQueryPredicate

class ResolutionDetailQueryPredicate extends Object implements Serializable

Serialized Fields

metric

ResolutionDetailQueryPredicate.MetricEnum metric

operator

ResolutionDetailQueryPredicate.OperatorEnum operator

range

NumericRange range

type

ResolutionDetailQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.ResourceConditionNode

class ResourceConditionNode extends Object implements Serializable

Serialized Fields

conjunction

ResourceConditionNode.ConjunctionEnum conjunction

operands

List<ResourceConditionValue> operands

operator

ResourceConditionNode.OperatorEnum operator

terms

List<ResourceConditionNode> terms

variableName

String variableName

Class com.mypurecloud.sdk.v2.model.ResourceConditionValue

class ResourceConditionValue extends Object implements Serializable

Serialized Fields

type

ResourceConditionValue.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.ResourcePermissionPolicy

class ResourcePermissionPolicy extends Object implements Serializable

Serialized Fields

actionSet

List<String> actionSet

actionSetKey

String actionSetKey

allowConditions

Boolean allowConditions

domain

String domain

entityName

String entityName

id

String id

namedResources

List<String> namedResources

policyDescription

String policyDescription

policyName

String policyName

resourceCondition

String resourceCondition

resourceConditionNode

ResourceConditionNode resourceConditionNode

Class com.mypurecloud.sdk.v2.model.Response

class Response extends Object implements Serializable

Serialized Fields

assets

List<AddressableEntityRef> assets

createdBy

User createdBy

dateCreated

Date dateCreated

footer

FooterTemplate footer

id

String id

interactionType

Response.InteractionTypeEnum interactionType

libraries

List<DomainEntityRef> libraries

messagingTemplate

MessagingTemplate messagingTemplate

name

String name

responseType

Response.ResponseTypeEnum responseType

selfUri

String selfUri

substitutions

List<ResponseSubstitution> substitutions

substitutionsSchema

JsonSchemaDocument substitutionsSchema

texts

List<ResponseText> texts

version

Integer version

Class com.mypurecloud.sdk.v2.model.ResponseAsset

class ResponseAsset extends Object implements Serializable

Serialized Fields

contentLength

Long contentLength

contentLocation

String contentLocation

contentType

String contentType

createdBy

DomainEntityRef createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

division

Division division

id

String id

modifiedBy

DomainEntityRef modifiedBy

name

String name

responses

List<DomainEntityRef> responses

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ResponseAssetFilter

class ResponseAssetFilter extends Object implements Serializable

Serialized Fields

endValue

String endValue

fields

List<String> fields

startValue

String startValue

type

ResponseAssetFilter.TypeEnum type

value

String value

values

List<String> values

Class com.mypurecloud.sdk.v2.model.ResponseAssetRequest

class ResponseAssetRequest extends Object implements Serializable

Serialized Fields

divisionId

String divisionId

name

String name

Class com.mypurecloud.sdk.v2.model.ResponseAssetSearchRequest

class ResponseAssetSearchRequest extends Object implements Serializable

Serialized Fields

pageNumber

Integer pageNumber

pageSize

Integer pageSize

query

List<ResponseAssetFilter> query

sortBy

String sortBy

sortOrder

ResponseAssetSearchRequest.SortOrderEnum sortOrder

Class com.mypurecloud.sdk.v2.model.ResponseAssetSearchResults

class ResponseAssetSearchResults extends Object implements Serializable

Serialized Fields

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

results

List<ResponseAsset> results

total

Long total

Class com.mypurecloud.sdk.v2.model.ResponseAssetStatus

class ResponseAssetStatus extends Object implements Serializable

Serialized Fields

errorCode

String errorCode

errorMessage

String errorMessage

id

String id

status

ResponseAssetStatus.StatusEnum status

Class com.mypurecloud.sdk.v2.model.ResponseConfig

class ResponseConfig extends Object implements Serializable

Serialized Fields

successTemplate

String successTemplate

successTemplateUri

String successTemplateUri

translationMap

Map<String,String> translationMap

translationMapDefaults

Map<String,String> translationMapDefaults

Class com.mypurecloud.sdk.v2.model.ResponseEntityList

class ResponseEntityList extends Object implements Serializable

Serialized Fields

entities

List<Response> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ResponseEntityListing

class ResponseEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Response> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ResponseFilter

class ResponseFilter extends Object implements Serializable

Serialized Fields

name

String name

operator

ResponseFilter.OperatorEnum operator

values

List<String> values

Class com.mypurecloud.sdk.v2.model.ResponseQueryRequest

class ResponseQueryRequest extends Object implements Serializable

Serialized Fields

filters

List<ResponseFilter> filters

pageSize

Integer pageSize

queryPhrase

String queryPhrase

Class com.mypurecloud.sdk.v2.model.ResponseQueryResults

class ResponseQueryResults extends Object implements Serializable

Serialized Fields

results

ResponseEntityList results

Class com.mypurecloud.sdk.v2.model.ResponseSet

class ResponseSet extends Object implements Serializable

Serialized Fields

amdSpeechDistinguishEnabled

Boolean amdSpeechDistinguishEnabled

beepDetectionEnabled

Boolean beepDetectionEnabled

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

name

String name

responses

Map<String,Reaction> responses

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.ResponseSetEntityListing

class ResponseSetEntityListing extends Object implements Serializable

Serialized Fields

entities

List<ResponseSet> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ResponseSubstitution

class ResponseSubstitution extends Object implements Serializable

Serialized Fields

defaultValue

String defaultValue

description

String description

id

String id

Class com.mypurecloud.sdk.v2.model.ResponseText

class ResponseText extends Object implements Serializable

Serialized Fields

content

String content

contentType

ResponseText.ContentTypeEnum contentType

Class com.mypurecloud.sdk.v2.model.RestErrorDetail

class RestErrorDetail extends Object implements Serializable

Serialized Fields

details

String details

error

String error

Class com.mypurecloud.sdk.v2.model.RestorePresenceSettings

class RestorePresenceSettings extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

restoreOnQueueEnabled

Boolean restoreOnQueueEnabled

restoreTimeMilliseconds

Long restoreTimeMilliseconds

Class com.mypurecloud.sdk.v2.model.ResultCounters

class ResultCounters extends Object implements Serializable

Serialized Fields

failure

Integer failure

success

Integer success

Class com.mypurecloud.sdk.v2.model.RetentionDuration

class RetentionDuration extends Object implements Serializable

Serialized Fields

archiveRetention

ArchiveRetention archiveRetention

deleteRetention

DeleteRetention deleteRetention

Class com.mypurecloud.sdk.v2.model.ReverseWhitepagesLookupResult

class ReverseWhitepagesLookupResult extends Object implements Serializable

Serialized Fields

contacts

List<ExternalContact> contacts

externalOrganizations

List<ExternalOrganization> externalOrganizations

Class com.mypurecloud.sdk.v2.model.ReviewAssessmentResults

class ReviewAssessmentResults extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.Ring

class Ring extends Object implements Serializable

Serialized Fields

actions

Actions actions

expansionCriteria

List<ExpansionCriterium> expansionCriteria

memberGroups

List<MemberGroup> memberGroups

Class com.mypurecloud.sdk.v2.model.RoleDivision

class RoleDivision extends Object implements Serializable

Serialized Fields

divisionId

String divisionId

roleId

String roleId

Class com.mypurecloud.sdk.v2.model.RoleDivisionGrants

class RoleDivisionGrants extends Object implements Serializable

Serialized Fields

grants

List<RoleDivisionPair> grants

Class com.mypurecloud.sdk.v2.model.RoleDivisionPair

class RoleDivisionPair extends Object implements Serializable

Serialized Fields

divisionId

String divisionId

roleId

String roleId

Class com.mypurecloud.sdk.v2.model.RoutePathRequest

class RoutePathRequest extends Object implements Serializable

Serialized Fields

languageId

String languageId

mediaType

RoutePathRequest.MediaTypeEnum mediaType

queueId

String queueId

skillIds

List<String> skillIds

sourcePlanningGroup

SourcePlanningGroupRequest sourcePlanningGroup

Class com.mypurecloud.sdk.v2.model.RoutePathResponse

class RoutePathResponse extends Object implements Serializable

Serialized Fields

language

LanguageReference language

mediaType

RoutePathResponse.MediaTypeEnum mediaType

queue

QueueReference queue

skills

List<RoutingSkillReference> skills

Class com.mypurecloud.sdk.v2.model.RoutingActivityData

class RoutingActivityData extends Object implements Serializable

Serialized Fields

data

List<RoutingActivityMetricValue> data

entities

List<RoutingActivityEntityData> entities

group

Map<String,String> group

truncated

Boolean truncated

Class com.mypurecloud.sdk.v2.model.RoutingActivityEntityData

class RoutingActivityEntityData extends Object implements Serializable

Serialized Fields

activityDate

Date activityDate

organizationPresenceId

String organizationPresenceId

presenceDate

Date presenceDate

queueId

String queueId

queueMembershipStatus

String queueMembershipStatus

routingStatus

String routingStatus

routingStatusDate

Date routingStatusDate

systemPresence

String systemPresence

teamId

String teamId

userId

String userId

Class com.mypurecloud.sdk.v2.model.RoutingActivityMetricValue

class RoutingActivityMetricValue extends Object implements Serializable

Serialized Fields

count

Integer count

metric

RoutingActivityMetricValue.MetricEnum metric

Class com.mypurecloud.sdk.v2.model.RoutingActivityQuery

class RoutingActivityQuery extends Object implements Serializable

Serialized Fields

filter

RoutingActivityQueryFilter filter

groupBy

List<RoutingActivityQuery.GroupByEnum> groupBy

metrics

List<RoutingActivityQueryMetric> metrics

order

RoutingActivityQuery.OrderEnum order

Class com.mypurecloud.sdk.v2.model.RoutingActivityQueryClause

class RoutingActivityQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<RoutingActivityQueryPredicate> predicates

type

RoutingActivityQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.RoutingActivityQueryFilter

class RoutingActivityQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<RoutingActivityQueryClause> clauses

predicates

List<RoutingActivityQueryPredicate> predicates

type

RoutingActivityQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.RoutingActivityQueryMetric

class RoutingActivityQueryMetric extends Object implements Serializable

Serialized Fields

details

Boolean details

metric

RoutingActivityQueryMetric.MetricEnum metric

Class com.mypurecloud.sdk.v2.model.RoutingActivityQueryPredicate

class RoutingActivityQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

RoutingActivityQueryPredicate.DimensionEnum dimension

operator

RoutingActivityQueryPredicate.OperatorEnum operator

type

RoutingActivityQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.RoutingActivityResponse

class RoutingActivityResponse extends Object implements Serializable

Serialized Fields

entityIdDimension

RoutingActivityResponse.EntityIdDimensionEnum entityIdDimension

results

List<RoutingActivityData> results

Class com.mypurecloud.sdk.v2.model.RoutingConversationAttributesRequest

class RoutingConversationAttributesRequest extends Object implements Serializable

Serialized Fields

languageId

String languageId

priority

Integer priority

requestScoredAgents

List<RequestScoredAgent> requestScoredAgents

skillIds

List<String> skillIds

Class com.mypurecloud.sdk.v2.model.RoutingConversationAttributesResponse

class RoutingConversationAttributesResponse extends Object implements Serializable

Serialized Fields

language

Language language

priority

Integer priority

scoredAgents

List<ScoredAgent> scoredAgents

skills

List<RoutingSkill> skills

Class com.mypurecloud.sdk.v2.model.RoutingData

class RoutingData extends Object implements Serializable

Serialized Fields

languageId

String languageId

preferredAgentIds

List<String> preferredAgentIds

priority

Integer priority

queueId

String queueId

routingFlags

List<String> routingFlags

scoredAgents

List<ScoredAgent> scoredAgents

skillIds

List<String> skillIds

Class com.mypurecloud.sdk.v2.model.RoutingEstablishedEvent

class RoutingEstablishedEvent extends Object implements Serializable

Serialized Fields

ani

String ani

communicationId

String communicationId

conversationId

String conversationId

dnis

String dnis

eventDateTime

Date eventDateTime

eventId

String eventId

initialConfiguration

InitialConfiguration initialConfiguration

languageId

String languageId

phoneNumber

String phoneNumber

queueId

String queueId

skillIds

List<String> skillIds

sourceConfiguration

SourceConfiguration sourceConfiguration

Class com.mypurecloud.sdk.v2.model.RoutingRule

class RoutingRule extends Object implements Serializable

Serialized Fields

operator

RoutingRule.OperatorEnum operator

threshold

Integer threshold

waitSeconds

Double waitSeconds

Class com.mypurecloud.sdk.v2.model.RoutingSettings

class RoutingSettings extends Object implements Serializable

Serialized Fields

resetAgentScoreOnPresenceChange

Boolean resetAgentScoreOnPresenceChange

Class com.mypurecloud.sdk.v2.model.RoutingSkill

class RoutingSkill extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

id

String id

name

String name

selfUri

String selfUri

state

RoutingSkill.StateEnum state

version

String version

Class com.mypurecloud.sdk.v2.model.RoutingSkillReference

class RoutingSkillReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.RoutingStatus

class RoutingStatus extends Object implements Serializable

Serialized Fields

startTime

Date startTime

status

RoutingStatus.StatusEnum status

userId

String userId

Class com.mypurecloud.sdk.v2.model.RoutingStatusDetailQueryClause

class RoutingStatusDetailQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<RoutingStatusDetailQueryPredicate> predicates

type

RoutingStatusDetailQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.RoutingStatusDetailQueryFilter

class RoutingStatusDetailQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<RoutingStatusDetailQueryClause> clauses

predicates

List<RoutingStatusDetailQueryPredicate> predicates

type

RoutingStatusDetailQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.RoutingStatusDetailQueryPredicate

class RoutingStatusDetailQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

RoutingStatusDetailQueryPredicate.DimensionEnum dimension

operator

RoutingStatusDetailQueryPredicate.OperatorEnum operator

range

NumericRange range

type

RoutingStatusDetailQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.RoutingTransferEvent

class RoutingTransferEvent extends Object implements Serializable

Serialized Fields

commandId

String commandId

conversationId

String conversationId

destinationQueueId

String destinationQueueId

eventDateTime

Date eventDateTime

eventId

String eventId

initiatingCommunicationId

String initiatingCommunicationId

languageId

String languageId

objectCommunicationId

String objectCommunicationId

skillIds

List<String> skillIds

targetCommunicationId

String targetCommunicationId

transferType

RoutingTransferEvent.TransferTypeEnum transferType

Class com.mypurecloud.sdk.v2.model.RuleSet

class RuleSet extends Object implements Serializable

Serialized Fields

contactList

DomainEntityRef contactList

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

name

String name

queue

DomainEntityRef queue

rules

List<DialerRule> rules

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.RuleSetDiagnostic

class RuleSetDiagnostic extends Object implements Serializable

Serialized Fields

ruleSet

DomainEntityRef ruleSet

warnings

List<RuleSetDiagnostic.WarningsEnum> warnings

Class com.mypurecloud.sdk.v2.model.RuleSetEntityListing

class RuleSetEntityListing extends Object implements Serializable

Serialized Fields

entities

List<RuleSet> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.RunNowResponse

class RunNowResponse extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.Salesforce

class Salesforce extends Object implements Serializable

Serialized Fields

certificate

String certificate

certificates

List<String> certificates

disabled

Boolean disabled

id

String id

issuerURI

String issuerURI

name

String name

relyingPartyIdentifier

String relyingPartyIdentifier

selfUri

String selfUri

sloBinding

String sloBinding

sloURI

String sloURI

ssoTargetURI

String ssoTargetURI

Class com.mypurecloud.sdk.v2.model.Schedule

class Schedule extends Object implements Serializable

Serialized Fields

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

WritableDivision division

end

org.joda.time.LocalDateTime end

id

String id

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

rrule

String rrule

selfUri

String selfUri

start

org.joda.time.LocalDateTime start

state

Schedule.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.ScheduleActivity

class ScheduleActivity extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

dateStart

Date dateStart

description

String description

externalActivityId

String externalActivityId

externalActivityType

ScheduleActivity.ExternalActivityTypeEnum externalActivityType

lengthMinutes

Integer lengthMinutes

paid

Boolean paid

timeOffRequestId

String timeOffRequestId

Class com.mypurecloud.sdk.v2.model.ScheduleEntityListing

class ScheduleEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Schedule> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ScheduleGenerationMessage

class ScheduleGenerationMessage extends Object implements Serializable

Serialized Fields

arguments

List<SchedulerMessageArgument> arguments

type

ScheduleGenerationMessage.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ScheduleGenerationResult

class ScheduleGenerationResult extends Object implements Serializable

Serialized Fields

failed

Boolean failed

messageCount

Integer messageCount

messages

List<ScheduleGenerationMessage> messages

messageSeverities

List<SchedulerMessageTypeSeverity> messageSeverities

runId

String runId

Class com.mypurecloud.sdk.v2.model.ScheduleGenerationResultSummary

class ScheduleGenerationResultSummary extends Object implements Serializable

Serialized Fields

failed

Boolean failed

messageCount

Integer messageCount

messageSeverityCounts

List<SchedulerMessageSeverityCount> messageSeverityCounts

runId

String runId

Class com.mypurecloud.sdk.v2.model.ScheduleGenerationWarning

class ScheduleGenerationWarning extends Object implements Serializable

Serialized Fields

noNeedDays

List<ScheduleGenerationWarning.NoNeedDaysEnum> noNeedDays

shiftsTooCloseTogether

Boolean shiftsTooCloseTogether

unableToMeetMaxDays

Boolean unableToMeetMaxDays

unableToMeetMaxPaidForTheWeek

Boolean unableToMeetMaxPaidForTheWeek

unableToMeetMinPaidForTheWeek

Boolean unableToMeetMinPaidForTheWeek

unableToScheduleRequiredDays

List<ScheduleGenerationWarning.UnableToScheduleRequiredDaysEnum> unableToScheduleRequiredDays

userId

String userId

userNotLicensed

Boolean userNotLicensed

Class com.mypurecloud.sdk.v2.model.ScheduleGroup

class ScheduleGroup extends Object implements Serializable

Serialized Fields

closedSchedules

List<DomainEntityRef> closedSchedules

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

WritableDivision division

holidaySchedules

List<DomainEntityRef> holidaySchedules

id

String id

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

openSchedules

List<DomainEntityRef> openSchedules

selfUri

String selfUri

state

ScheduleGroup.StateEnum state

timeZone

String timeZone

version

Integer version

Class com.mypurecloud.sdk.v2.model.ScheduleGroupEntityListing

class ScheduleGroupEntityListing extends Object implements Serializable

Serialized Fields

entities

List<ScheduleGroup> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ScheduleInterval

class ScheduleInterval extends Object implements Serializable

Serialized Fields

end

String end

start

String start

Class com.mypurecloud.sdk.v2.model.SchedulerMessageArgument

class SchedulerMessageArgument extends Object implements Serializable

Serialized Fields

type

SchedulerMessageArgument.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.SchedulerMessageSeverityCount

class SchedulerMessageSeverityCount extends Object implements Serializable

Serialized Fields

count

Integer count

severity

SchedulerMessageSeverityCount.SeverityEnum severity

Class com.mypurecloud.sdk.v2.model.SchedulerMessageTypeSeverity

class SchedulerMessageTypeSeverity extends Object implements Serializable

Serialized Fields

severity

SchedulerMessageTypeSeverity.SeverityEnum severity

type

SchedulerMessageTypeSeverity.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ScheduleUploadProcessingResponse

class ScheduleUploadProcessingResponse extends Object implements Serializable

Serialized Fields

operationId

String operationId

result

BuScheduleMetadata result

status

ScheduleUploadProcessingResponse.StatusEnum status

Class com.mypurecloud.sdk.v2.model.SchedulingNoForecastOptionsRequest

class SchedulingNoForecastOptionsRequest extends Object implements Serializable

Serialized Fields

shiftLength

SchedulingNoForecastOptionsRequest.ShiftLengthEnum shiftLength

shiftStart

SchedulingNoForecastOptionsRequest.ShiftStartEnum shiftStart

Class com.mypurecloud.sdk.v2.model.SchedulingOptionsRequest

class SchedulingOptionsRequest extends Object implements Serializable

Serialized Fields

noForecastOptions

SchedulingNoForecastOptionsRequest noForecastOptions

Class com.mypurecloud.sdk.v2.model.SchedulingProcessingError

class SchedulingProcessingError extends Object implements Serializable

Serialized Fields

description

String description

internalErrorCode

SchedulingProcessingError.InternalErrorCodeEnum internalErrorCode

Class com.mypurecloud.sdk.v2.model.SchedulingSettingsRequest

class SchedulingSettingsRequest extends Object implements Serializable

Serialized Fields

defaultShrinkagePercent

Double defaultShrinkagePercent

maxOccupancyPercentForDeferredWork

Integer maxOccupancyPercentForDeferredWork

planningPeriod

ValueWrapperPlanningPeriodSettings planningPeriod

shrinkageOverrides

ShrinkageOverrides shrinkageOverrides

startDayOfWeekend

SchedulingSettingsRequest.StartDayOfWeekendEnum startDayOfWeekend

Class com.mypurecloud.sdk.v2.model.SchedulingSettingsResponse

class SchedulingSettingsResponse extends Object implements Serializable

Serialized Fields

defaultShrinkagePercent

Double defaultShrinkagePercent

maxOccupancyPercentForDeferredWork

Integer maxOccupancyPercentForDeferredWork

planningPeriod

PlanningPeriodSettings planningPeriod

shrinkageOverrides

ShrinkageOverrides shrinkageOverrides

startDayOfWeekend

SchedulingSettingsResponse.StartDayOfWeekendEnum startDayOfWeekend

Class com.mypurecloud.sdk.v2.model.SchedulingStatusResponse

class SchedulingStatusResponse extends Object implements Serializable

Serialized Fields

errorDetails

List<SchedulingProcessingError> errorDetails

id

String id

percentComplete

Integer percentComplete

schedulingResultUri

String schedulingResultUri

status

SchedulingStatusResponse.StatusEnum status

Class com.mypurecloud.sdk.v2.model.SchedulingTestingOptionsRequest

class SchedulingTestingOptionsRequest extends Object implements Serializable

Serialized Fields

delayScheduling

Boolean delayScheduling

failScheduling

Boolean failScheduling

fastScheduling

Boolean fastScheduling

populateDeprecatedWarnings

Boolean populateDeprecatedWarnings

populateWarnings

Boolean populateWarnings

Class com.mypurecloud.sdk.v2.model.Schema

class Schema extends Object implements Serializable

Serialized Fields

description

String description

items

Items items

pattern

String pattern

title

String title

type

List<String> type

Class com.mypurecloud.sdk.v2.model.SchemaQuantityLimits

class SchemaQuantityLimits extends Object implements Serializable

Serialized Fields

id

String id

maxFieldDescriptionCharacters

Integer maxFieldDescriptionCharacters

maxFieldNameCharacters

Integer maxFieldNameCharacters

maxNumberOfFieldsPerOrg

Integer maxNumberOfFieldsPerOrg

maxNumberOfFieldsPerSchema

Integer maxNumberOfFieldsPerSchema

maxNumberOfSchemasPerOrg

Integer maxNumberOfSchemasPerOrg

maxSchemaDescriptionCharacters

Integer maxSchemaDescriptionCharacters

maxSchemaNameCharacters

Integer maxSchemaNameCharacters

minFieldDescriptionCharacters

Integer minFieldDescriptionCharacters

minFieldNameCharacters

Integer minFieldNameCharacters

minSchemaDescriptionCharacters

Integer minSchemaDescriptionCharacters

minSchemaNameCharacters

Integer minSchemaNameCharacters

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ScimConfigResourceType

class ScimConfigResourceType extends Object implements Serializable

Serialized Fields

description

String description

endpoint

String endpoint

id

String id

meta

ScimMetadata meta

name

String name

schema

String schema

schemaExtensions

List<ScimConfigResourceTypeSchemaExtension> schemaExtensions

schemas

List<String> schemas

Class com.mypurecloud.sdk.v2.model.ScimConfigResourceTypeSchemaExtension

class ScimConfigResourceTypeSchemaExtension extends Object implements Serializable

Serialized Fields

required

Boolean required

schema

String schema

Class com.mypurecloud.sdk.v2.model.ScimConfigResourceTypesListResponse

class ScimConfigResourceTypesListResponse extends Object implements Serializable

Serialized Fields

itemsPerPage

Long itemsPerPage

resources

List<ScimConfigResourceType> resources

schemas

List<String> schemas

startIndex

Long startIndex

totalResults

Long totalResults

Class com.mypurecloud.sdk.v2.model.ScimEmail

class ScimEmail extends Object implements Serializable

Serialized Fields

primary

Boolean primary

type

ScimEmail.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.ScimError

class ScimError extends Object implements Serializable

Serialized Fields

detail

String detail

schemas

List<String> schemas

scimType

ScimError.ScimTypeEnum scimType

status

String status

Class com.mypurecloud.sdk.v2.model.ScimGenesysUserExternalId

class ScimGenesysUserExternalId extends Object implements Serializable

Serialized Fields

authority

String authority

value

String value

Class com.mypurecloud.sdk.v2.model.ScimGroupListResponse

class ScimGroupListResponse extends Object implements Serializable

Serialized Fields

itemsPerPage

Long itemsPerPage

resources

List<ScimV2Group> resources

schemas

List<String> schemas

startIndex

Long startIndex

totalResults

Long totalResults

Class com.mypurecloud.sdk.v2.model.ScimMetadata

class ScimMetadata extends Object implements Serializable

Serialized Fields

lastModified

Date lastModified

location

String location

resourceType

ScimMetadata.ResourceTypeEnum resourceType

version

String version

Class com.mypurecloud.sdk.v2.model.ScimPhoneNumber

class ScimPhoneNumber extends Object implements Serializable

Serialized Fields

primary

Boolean primary

type

ScimPhoneNumber.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.ScimServiceProviderConfig

class ScimServiceProviderConfig extends Object implements Serializable

Serialized Fields

authenticationSchemes

List<ScimServiceProviderConfigAuthenticationScheme> authenticationSchemes

bulk

ScimServiceProviderConfigBulkFeature bulk

changePassword

ScimServiceProviderConfigSimpleFeature changePassword

documentationUri

String documentationUri

etag

ScimServiceProviderConfigSimpleFeature etag

filter

ScimServiceProviderConfigFilterFeature filter

meta

ScimMetadata meta

patch

ScimServiceProviderConfigSimpleFeature patch

schemas

List<String> schemas

sort

ScimServiceProviderConfigSimpleFeature sort

Class com.mypurecloud.sdk.v2.model.ScimServiceProviderConfigAuthenticationScheme

class ScimServiceProviderConfigAuthenticationScheme extends Object implements Serializable

Serialized Fields

description

String description

documentationUri

String documentationUri

name

String name

primary

Boolean primary

specUri

String specUri

type

ScimServiceProviderConfigAuthenticationScheme.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ScimServiceProviderConfigBulkFeature

class ScimServiceProviderConfigBulkFeature extends Object implements Serializable

Serialized Fields

maxOperations

Integer maxOperations

maxPayloadSize

Integer maxPayloadSize

supported

Boolean supported

Class com.mypurecloud.sdk.v2.model.ScimServiceProviderConfigFilterFeature

class ScimServiceProviderConfigFilterFeature extends Object implements Serializable

Serialized Fields

maxResults

Integer maxResults

supported

Boolean supported

Class com.mypurecloud.sdk.v2.model.ScimServiceProviderConfigSimpleFeature

class ScimServiceProviderConfigSimpleFeature extends Object implements Serializable

Serialized Fields

supported

Boolean supported

Class com.mypurecloud.sdk.v2.model.ScimUserExtensions

class ScimUserExtensions extends Object implements Serializable

Serialized Fields

externalIds

List<ScimGenesysUserExternalId> externalIds

routingLanguages

List<ScimUserRoutingLanguage> routingLanguages

routingSkills

List<ScimUserRoutingSkill> routingSkills

Class com.mypurecloud.sdk.v2.model.ScimUserListResponse

class ScimUserListResponse extends Object implements Serializable

Serialized Fields

itemsPerPage

Long itemsPerPage

resources

List<ScimV2User> resources

schemas

List<String> schemas

startIndex

Long startIndex

totalResults

Long totalResults

Class com.mypurecloud.sdk.v2.model.ScimUserRole

class ScimUserRole extends Object implements Serializable

Serialized Fields

value

String value

Class com.mypurecloud.sdk.v2.model.ScimUserRoutingLanguage

class ScimUserRoutingLanguage extends Object implements Serializable

Serialized Fields

name

String name

proficiency

Double proficiency

Class com.mypurecloud.sdk.v2.model.ScimUserRoutingSkill

class ScimUserRoutingSkill extends Object implements Serializable

Serialized Fields

name

String name

proficiency

Double proficiency

Class com.mypurecloud.sdk.v2.model.ScimV2CreateUser

class ScimV2CreateUser extends Object implements Serializable

Serialized Fields

active

Boolean active

displayName

String displayName

emails

List<ScimEmail> emails

externalId

String externalId

groups

List<ScimV2GroupReference> groups

password

String password

phoneNumbers

List<ScimPhoneNumber> phoneNumbers

roles

List<ScimUserRole> roles

schemas

List<String> schemas

title

String title

urnietfparamsscimschemasextensionenterprise20User

ScimV2EnterpriseUser urnietfparamsscimschemasextensionenterprise20User

urnietfparamsscimschemasextensiongenesyspurecloud20User

ScimUserExtensions urnietfparamsscimschemasextensiongenesyspurecloud20User

userName

String userName

Class com.mypurecloud.sdk.v2.model.ScimV2EnterpriseUser

class ScimV2EnterpriseUser extends Object implements Serializable

Serialized Fields

department

String department

division

String division

employeeNumber

String employeeNumber

manager

Manager manager

Class com.mypurecloud.sdk.v2.model.ScimV2Group

class ScimV2Group extends Object implements Serializable

Serialized Fields

displayName

String displayName

externalId

String externalId

id

String id

members

List<ScimV2MemberReference> members

meta

ScimMetadata meta

schemas

List<String> schemas

Class com.mypurecloud.sdk.v2.model.ScimV2GroupReference

class ScimV2GroupReference extends Object implements Serializable

Serialized Fields

ref

String ref

type

ScimV2GroupReference.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.ScimV2MemberReference

class ScimV2MemberReference extends Object implements Serializable

Serialized Fields

ref

String ref

type

ScimV2MemberReference.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.ScimV2PatchOperation

class ScimV2PatchOperation extends Object implements Serializable

Serialized Fields

op

ScimV2PatchOperation.OpEnum op

path

String path

value

com.fasterxml.jackson.databind.JsonNode value

Class com.mypurecloud.sdk.v2.model.ScimV2PatchRequest

class ScimV2PatchRequest extends Object implements Serializable

Serialized Fields

operations

List<ScimV2PatchOperation> operations

schemas

List<String> schemas

Class com.mypurecloud.sdk.v2.model.ScimV2SchemaAttribute

class ScimV2SchemaAttribute extends Object implements Serializable

Serialized Fields

canonicalValues

List<String> canonicalValues

caseExact

Boolean caseExact

description

String description

multiValued

Boolean multiValued

mutability

ScimV2SchemaAttribute.MutabilityEnum mutability

name

String name

referenceTypes

List<ScimV2SchemaAttribute.ReferenceTypesEnum> referenceTypes

required

Boolean required

returned

ScimV2SchemaAttribute.ReturnedEnum returned

subAttributes

List<ScimV2SchemaAttribute> subAttributes

type

ScimV2SchemaAttribute.TypeEnum type

uniqueness

ScimV2SchemaAttribute.UniquenessEnum uniqueness

Class com.mypurecloud.sdk.v2.model.ScimV2SchemaDefinition

class ScimV2SchemaDefinition extends Object implements Serializable

Serialized Fields

attributes

List<ScimV2SchemaAttribute> attributes

description

String description

id

String id

meta

ScimMetadata meta

name

String name

Class com.mypurecloud.sdk.v2.model.ScimV2SchemaListResponse

class ScimV2SchemaListResponse extends Object implements Serializable

Serialized Fields

itemsPerPage

Long itemsPerPage

resources

List<ScimV2SchemaDefinition> resources

schemas

List<String> schemas

startIndex

Long startIndex

totalResults

Long totalResults

Class com.mypurecloud.sdk.v2.model.ScimV2User

class ScimV2User extends Object implements Serializable

Serialized Fields

active

Boolean active

displayName

String displayName

emails

List<ScimEmail> emails

externalId

String externalId

groups

List<ScimV2GroupReference> groups

id

String id

meta

ScimMetadata meta

password

String password

phoneNumbers

List<ScimPhoneNumber> phoneNumbers

roles

List<ScimUserRole> roles

schemas

List<String> schemas

title

String title

urnietfparamsscimschemasextensionenterprise20User

ScimV2EnterpriseUser urnietfparamsscimschemasextensionenterprise20User

urnietfparamsscimschemasextensiongenesyspurecloud20User

ScimUserExtensions urnietfparamsscimschemasextensiongenesyspurecloud20User

userName

String userName

Class com.mypurecloud.sdk.v2.model.ScorableSurvey

class ScorableSurvey extends Object implements Serializable

Serialized Fields

answers

SurveyScoringSet answers

id

String id

name

String name

selfUri

String selfUri

status

ScorableSurvey.StatusEnum status

surveyForm

SurveyForm surveyForm

Class com.mypurecloud.sdk.v2.model.ScoredAgent

class ScoredAgent extends Object implements Serializable

Serialized Fields

agent

DomainEntityRef agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.ScreenRecordingMetaData

class ScreenRecordingMetaData extends Object implements Serializable

Serialized Fields

main

Boolean main

mediaId

String mediaId

originX

Integer originX

originY

Integer originY

primary

Boolean primary

screenId

String screenId

trackId

String trackId

Class com.mypurecloud.sdk.v2.model.ScreenRecordingMetaDataRequest

class ScreenRecordingMetaDataRequest extends Object implements Serializable

Serialized Fields

metaData

List<ScreenRecordingMetaData> metaData

participantJid

String participantJid

roomId

String roomId

Class com.mypurecloud.sdk.v2.model.ScreenRecordingSession

class ScreenRecordingSession extends Object implements Serializable

Serialized Fields

communicationId

String communicationId

conversation

Conversation conversation

id

String id

name

String name

selfUri

String selfUri

startTime

Date startTime

user

User user

Class com.mypurecloud.sdk.v2.model.ScreenRecordingSessionListing

class ScreenRecordingSessionListing extends Object implements Serializable

Serialized Fields

entities

List<ScreenRecordingSession> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ScreenRecordingSessionRequest

class ScreenRecordingSessionRequest extends Object implements Serializable

Serialized Fields

archiveDate

Date archiveDate

deleteDate

Date deleteDate

state

ScreenRecordingSessionRequest.StateEnum state

Class com.mypurecloud.sdk.v2.model.Screenshare

class Screenshare extends Object implements Serializable

Serialized Fields

afterCallWork

AfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

connectedTime

Date connectedTime

context

String context

disconnectedTime

Date disconnectedTime

disconnectType

Screenshare.DisconnectTypeEnum disconnectType

id

String id

initialState

Screenshare.InitialStateEnum initialState

peerCount

Integer peerCount

peerId

String peerId

provider

String provider

segments

List<Segment> segments

sharing

Boolean sharing

startAlertingTime

Date startAlertingTime

state

Screenshare.StateEnum state

wrapup

Wrapup wrapup

Class com.mypurecloud.sdk.v2.model.Script

class Script extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

customActions

Object customActions

division

Division division

features

Object features

id

String id

modifiedDate

Date modifiedDate

name

String name

pages

List<Page> pages

publishedDate

Date publishedDate

selfUri

String selfUri

startPageId

String startPageId

startPageName

String startPageName

variables

Object variables

versionDate

Date versionDate

versionId

String versionId

Class com.mypurecloud.sdk.v2.model.ScriptEntityListing

class ScriptEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Script> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ScrollPercentageEventTrigger

class ScrollPercentageEventTrigger extends Object implements Serializable

Serialized Fields

eventName

String eventName

percentage

Integer percentage

Class com.mypurecloud.sdk.v2.model.SdkLibrary

class SdkLibrary extends Object implements Serializable

Serialized Fields

name

String name

version

String version

Class com.mypurecloud.sdk.v2.model.SearchAggregation

class SearchAggregation extends Object implements Serializable

Serialized Fields

field

String field

name

String name

order

List<SearchAggregation.OrderEnum> order

size

Integer size

type

SearchAggregation.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.SearchCriteria

class SearchCriteria extends Object implements Serializable

Serialized Fields

dateFormat

String dateFormat

endValue

String endValue

fields

List<String> fields

group

List<SearchCriteria> group

operator

SearchCriteria.OperatorEnum operator

startValue

String startValue

type

SearchCriteria.TypeEnum type

value

String value

values

List<String> values

Class com.mypurecloud.sdk.v2.model.SearchRequest

class SearchRequest extends Object implements Serializable

Serialized Fields

aggregations

List<SearchAggregation> aggregations

expand

List<String> expand

pageNumber

Integer pageNumber

pageSize

Integer pageSize

query

List<SearchCriteria> query

returnFields

List<String> returnFields

sort

List<SearchSort> sort

sortBy

String sortBy

sortOrder

SearchRequest.SortOrderEnum sortOrder

types

List<String> types

Class com.mypurecloud.sdk.v2.model.SearchShiftTradeResponse

class SearchShiftTradeResponse extends Object implements Serializable

Serialized Fields

matchingReceivingShiftIds

List<String> matchingReceivingShiftIds

preview

ShiftTradePreviewResponse preview

trade

ShiftTradeResponse trade

Class com.mypurecloud.sdk.v2.model.SearchShiftTradesRequest

class SearchShiftTradesRequest extends Object implements Serializable

Serialized Fields

receivingScheduleId

String receivingScheduleId

receivingShiftIds

List<String> receivingShiftIds

Class com.mypurecloud.sdk.v2.model.SearchShiftTradesResponse

class SearchShiftTradesResponse extends Object implements Serializable

Serialized Fields

trades

List<SearchShiftTradeResponse> trades

Class com.mypurecloud.sdk.v2.model.SearchSort

class SearchSort extends Object implements Serializable

Serialized Fields

sortBy

String sortBy

sortOrder

SearchSort.SortOrderEnum sortOrder

Class com.mypurecloud.sdk.v2.model.SearchUpdateRequest

class SearchUpdateRequest extends Object implements Serializable

Serialized Fields

answered

Boolean answered

selectedAnswer

SelectedAnswer selectedAnswer

sessionId

String sessionId

Class com.mypurecloud.sdk.v2.model.SecondaryPresence

class SecondaryPresence extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.Section

class Section extends Object implements Serializable

Serialized Fields

fieldList

List<FieldList> fieldList

instructionText

String instructionText

key

String key

state

String state

Class com.mypurecloud.sdk.v2.model.SecureSession

class SecureSession extends Object implements Serializable

Serialized Fields

disconnect

Boolean disconnect

flow

DomainEntityRef flow

id

String id

selfUri

String selfUri

sourceParticipantId

String sourceParticipantId

state

SecureSession.StateEnum state

userData

String userData

Class com.mypurecloud.sdk.v2.model.SecureSessionEntityListing

class SecureSessionEntityListing extends Object implements Serializable

Serialized Fields

entities

List<SecureSession> entities

Class com.mypurecloud.sdk.v2.model.SecurityProfile

class SecurityProfile extends Object implements Serializable

Serialized Fields

id

String id

name

String name

permissions

List<String> permissions

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.SecurityProfileEntityListing

class SecurityProfileEntityListing extends Object implements Serializable

Serialized Fields

entities

List<SecurityProfile> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.Segment

class Segment extends Object implements Serializable

Serialized Fields

disconnectType

String disconnectType

endTime

Date endTime

howEnded

String howEnded

startTime

Date startTime

type

String type

Class com.mypurecloud.sdk.v2.model.SegmentAssignedEvent

class SegmentAssignedEvent extends Object implements Serializable

Serialized Fields

browser

Browser browser

device

Device device

geolocation

JourneyGeolocation geolocation

ipAddress

String ipAddress

ipOrganization

String ipOrganization

mktCampaign

JourneyCampaign mktCampaign

segment

SegmentAssignedEventSegment segment

userAgentString

String userAgentString

visitCreatedDate

Date visitCreatedDate

visitReferrer

Referrer visitReferrer

Class com.mypurecloud.sdk.v2.model.SegmentAssignedEventSegment

class SegmentAssignedEventSegment extends Object implements Serializable

Serialized Fields

displayName

String displayName

id

String id

scope

SegmentAssignedEventSegment.ScopeEnum scope

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.SegmentAssignment

class SegmentAssignment extends Object implements Serializable

Serialized Fields

customerId

String customerId

customerIdType

String customerIdType

dateAssigned

Date dateAssigned

dateModified

Date dateModified

dateUnassigned

Date dateUnassigned

externalContact

AddressableEntityRef externalContact

id

String id

segment

SegmentAssignmentSegment segment

session

SegmentAssignmentSession session

state

SegmentAssignment.StateEnum state

Class com.mypurecloud.sdk.v2.model.SegmentAssignmentEvent

class SegmentAssignmentEvent extends Object implements Serializable

Serialized Fields

segment

AddressableEntityRef segment

Class com.mypurecloud.sdk.v2.model.SegmentAssignmentListing

class SegmentAssignmentListing extends Object implements Serializable

Serialized Fields

entities

List<SegmentAssignment> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.SegmentAssignmentSegment

class SegmentAssignmentSegment extends Object implements Serializable

Serialized Fields

id

String id

scope

SegmentAssignmentSegment.ScopeEnum scope

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.SegmentAssignmentSession

class SegmentAssignmentSession extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

type

String type

Class com.mypurecloud.sdk.v2.model.SegmentDetailQueryClause

class SegmentDetailQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<SegmentDetailQueryPredicate> predicates

type

SegmentDetailQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.SegmentDetailQueryFilter

class SegmentDetailQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<SegmentDetailQueryClause> clauses

predicates

List<SegmentDetailQueryPredicate> predicates

type

SegmentDetailQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.SegmentDetailQueryPredicate

class SegmentDetailQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

SegmentDetailQueryPredicate.DimensionEnum dimension

metric

SegmentDetailQueryPredicate.MetricEnum metric

operator

SegmentDetailQueryPredicate.OperatorEnum operator

property

String property

propertyType

SegmentDetailQueryPredicate.PropertyTypeEnum propertyType

range

NumericRange range

type

SegmentDetailQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.SegmentEstimateCount

class SegmentEstimateCount extends Object implements Serializable

Serialized Fields

count

Integer count

segmentId

String segmentId

Class com.mypurecloud.sdk.v2.model.SegmentListing

class SegmentListing extends Object implements Serializable

Serialized Fields

entities

List<JourneySegment> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.SelectedAnswer

class SelectedAnswer extends Object implements Serializable

Serialized Fields

document

AddressableEntityRef document

Class com.mypurecloud.sdk.v2.model.SelectedColumns

class SelectedColumns extends Object implements Serializable

Serialized Fields

columnName

String columnName

columnOrder

Integer columnOrder

Class com.mypurecloud.sdk.v2.model.SelectorEventTrigger

class SelectorEventTrigger extends Object implements Serializable

Serialized Fields

eventName

String eventName

selector

String selector

Class com.mypurecloud.sdk.v2.model.SendAgentlessOutboundMessageRequest

class SendAgentlessOutboundMessageRequest extends Object implements Serializable

Serialized Fields

fromAddress

String fromAddress

messagingTemplate

MessagingTemplateRequest messagingTemplate

textBody

String textBody

toAddress

String toAddress

toAddressMessengerType

SendAgentlessOutboundMessageRequest.ToAddressMessengerTypeEnum toAddressMessengerType

useExistingActiveConversation

Boolean useExistingActiveConversation

Class com.mypurecloud.sdk.v2.model.SendAgentlessOutboundMessageResponse

class SendAgentlessOutboundMessageResponse extends Object implements Serializable

Serialized Fields

conversationId

String conversationId

fromAddress

String fromAddress

id

String id

messagingTemplate

MessagingTemplateRequest messagingTemplate

messengerType

SendAgentlessOutboundMessageResponse.MessengerTypeEnum messengerType

selfUri

String selfUri

textBody

String textBody

timestamp

Date timestamp

toAddress

String toAddress

useExistingActiveConversation

Boolean useExistingActiveConversation

user

AddressableEntityRef user

Class com.mypurecloud.sdk.v2.model.SentimentFeedback

class SentimentFeedback extends Object implements Serializable

Serialized Fields

createdBy

AddressableEntityRef createdBy

dateCreated

Date dateCreated

dialect

String dialect

feedbackValue

SentimentFeedback.FeedbackValueEnum feedbackValue

id

String id

phrase

String phrase

Class com.mypurecloud.sdk.v2.model.SentimentFeedbackEntityListing

class SentimentFeedbackEntityListing extends Object implements Serializable

Serialized Fields

entities

List<SentimentFeedback> entities

Class com.mypurecloud.sdk.v2.model.SequenceSchedule

class SequenceSchedule extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

intervals

List<ScheduleInterval> intervals

name

String name

selfUri

String selfUri

sequence

DomainEntityRef sequence

timeZone

String timeZone

version

Integer version

Class com.mypurecloud.sdk.v2.model.ServerDate

class ServerDate extends Object implements Serializable

Serialized Fields

currentDate

Date currentDate

Class com.mypurecloud.sdk.v2.model.ServiceContext

class ServiceContext extends Object implements Serializable

Serialized Fields

name

String name

Class com.mypurecloud.sdk.v2.model.ServiceGoalTemplate

class ServiceGoalTemplate extends Object implements Serializable

Serialized Fields

abandonRate

BuAbandonRate abandonRate

averageSpeedOfAnswer

BuAverageSpeedOfAnswer averageSpeedOfAnswer

id

String id

metadata

WfmVersionedEntityMetadata metadata

name

String name

selfUri

String selfUri

serviceLevel

BuServiceLevel serviceLevel

Class com.mypurecloud.sdk.v2.model.ServiceGoalTemplateImpactOverride

class ServiceGoalTemplateImpactOverride extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

impact

WfmServiceGoalImpactSettings impact

Class com.mypurecloud.sdk.v2.model.ServiceGoalTemplateList

class ServiceGoalTemplateList extends Object implements Serializable

Serialized Fields

entities

List<ServiceGoalTemplate> entities

Class com.mypurecloud.sdk.v2.model.ServiceGoalTemplateReference

class ServiceGoalTemplateReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.ServiceLevel

class ServiceLevel extends Object implements Serializable

Serialized Fields

durationMs

Long durationMs

percentage

Double percentage

Class com.mypurecloud.sdk.v2.model.Session

class Session extends Object implements Serializable

Serialized Fields

attributeLists

Map<String,CustomEventAttributeList> attributeLists

attributes

Map<String,CustomEventAttribute> attributes

authenticated

Boolean authenticated

awayDate

Date awayDate

browser

Browser browser

conversation

AddressableEntityRef conversation

conversationChannels

List<ConversationChannel> conversationChannels

conversationSubject

String conversationSubject

createdDate

Date createdDate

customerId

String customerId

customerIdType

String customerIdType

device

Device device

durationInSeconds

Integer durationInSeconds

endedDate

Date endedDate

eventCount

Integer eventCount

externalContact

AddressableEntityRef externalContact

externalId

String externalId

externalUrl

String externalUrl

geolocation

JourneyGeolocation geolocation

id

String id

idleDate

Date idleDate

ipAddress

String ipAddress

ipOrganization

String ipOrganization

lastAcdOutcome

Session.LastAcdOutcomeEnum lastAcdOutcome

lastConnectedQueue

ConnectedQueue lastConnectedQueue

lastConnectedUser

ConnectedUser lastConnectedUser

lastEvent

SessionLastEvent lastEvent

lastPage

JourneyPage lastPage

lastUserDisconnectType

Session.LastUserDisconnectTypeEnum lastUserDisconnectType

lastUserDisposition

ConversationUserDisposition lastUserDisposition

mktCampaign

JourneyCampaign mktCampaign

originatingDirection

Session.OriginatingDirectionEnum originatingDirection

outcomeAchievements

List<OutcomeAchievement> outcomeAchievements

pageviewCount

Integer pageviewCount

referrer

Referrer referrer

screenviewCount

Integer screenviewCount

searchTerms

List<String> searchTerms

segmentAssignments

List<SessionSegmentAssignment> segmentAssignments

selfUri

String selfUri

shortId

String shortId

type

String type

userAgentString

String userAgentString

Class com.mypurecloud.sdk.v2.model.SessionEndDetails

class SessionEndDetails extends Object implements Serializable

Serialized Fields

reason

String reason

type

SessionEndDetails.TypeEnum type

Class com.mypurecloud.sdk.v2.model.SessionLastEvent

class SessionLastEvent extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

eventName

String eventName

id

String id

Class com.mypurecloud.sdk.v2.model.SessionListing

class SessionListing extends Object implements Serializable

Serialized Fields

entities

List<Session> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.SessionSegmentAssignment

class SessionSegmentAssignment extends Object implements Serializable

Serialized Fields

assignedDate

Date assignedDate

segment

AssignedSegment segment

Class com.mypurecloud.sdk.v2.model.SetContentTemplateActionSettings

class SetContentTemplateActionSettings extends Object implements Serializable

Serialized Fields

emailContentTemplateId

String emailContentTemplateId

smsContentTemplateId

String smsContentTemplateId

Class com.mypurecloud.sdk.v2.model.SetRecordingState

class SetRecordingState extends Object implements Serializable

Serialized Fields

recordingState

SetRecordingState.RecordingStateEnum recordingState

Class com.mypurecloud.sdk.v2.model.SetSmsPhoneNumberActionSettings

class SetSmsPhoneNumberActionSettings extends Object implements Serializable

Serialized Fields

senderSmsPhoneNumber

String senderSmsPhoneNumber

Class com.mypurecloud.sdk.v2.model.SetTimeOffLimitValuesRequest

class SetTimeOffLimitValuesRequest extends Object implements Serializable

Serialized Fields

metadata

WfmVersionedEntityMetadata metadata

values

List<TimeOffLimitRange> values

Class com.mypurecloud.sdk.v2.model.SettingDirection

class SettingDirection extends Object implements Serializable

Serialized Fields

inbound

SettingDirection.InboundEnum inbound

outbound

SettingDirection.OutboundEnum outbound

Class com.mypurecloud.sdk.v2.model.Settings

class Settings extends Object implements Serializable

Serialized Fields

allowCallbackQueueSelection

Boolean allowCallbackQueueSelection

communicationBasedACW

Boolean communicationBasedACW

completeAcwWhenAgentTransitionsOffline

Boolean completeAcwWhenAgentTransitionsOffline

includeNonAgentConversationSummary

Boolean includeNonAgentConversationSummary

totalActiveCallback

Boolean totalActiveCallback

Class com.mypurecloud.sdk.v2.model.SetUuiDataRequest

class SetUuiDataRequest extends Object implements Serializable

Serialized Fields

uuiData

String uuiData

Class com.mypurecloud.sdk.v2.model.SetWrapperDayOfWeek

class SetWrapperDayOfWeek extends Object implements Serializable

Serialized Fields

values

List<SetWrapperDayOfWeek.ValuesEnum> values

Class com.mypurecloud.sdk.v2.model.SetWrapperRoutePathRequest

class SetWrapperRoutePathRequest extends Object implements Serializable

Serialized Fields

values

List<RoutePathRequest> values

Class com.mypurecloud.sdk.v2.model.SetWrapperString

class SetWrapperString extends Object implements Serializable

Serialized Fields

values

List<String> values

Class com.mypurecloud.sdk.v2.model.SetWrapperSyncTimeOffProperty

class SetWrapperSyncTimeOffProperty extends Object implements Serializable

Serialized Fields

values

List<SetWrapperSyncTimeOffProperty.ValuesEnum> values

Class com.mypurecloud.sdk.v2.model.Share

class Share extends Object implements Serializable

Serialized Fields

group

Group group

id

String id

member

DomainEntityRef member

memberType

Share.MemberTypeEnum memberType

name

String name

selfUri

String selfUri

sharedBy

DomainEntityRef sharedBy

sharedEntity

DomainEntityRef sharedEntity

sharedEntityType

Share.SharedEntityTypeEnum sharedEntityType

user

User user

workspace

DomainEntityRef workspace

Class com.mypurecloud.sdk.v2.model.SharedEntity

class SharedEntity extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.SharedResponse

class SharedResponse extends Object implements Serializable

Serialized Fields

document

Document document

downloadUri

String downloadUri

id

String id

share

Share share

viewUri

String viewUri

Class com.mypurecloud.sdk.v2.model.ShareEntityListing

class ShareEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Share> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.ShiftStartVariance

class ShiftStartVariance extends Object implements Serializable

Serialized Fields

applicableDays

List<ShiftStartVariance.ApplicableDaysEnum> applicableDays

maxShiftStartVarianceMinutes

Integer maxShiftStartVarianceMinutes

Class com.mypurecloud.sdk.v2.model.ShiftTradeActivityPreviewResponse

class ShiftTradeActivityPreviewResponse extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

countsAsPaidTime

Boolean countsAsPaidTime

lengthMinutes

Integer lengthMinutes

startDate

Date startDate

Class com.mypurecloud.sdk.v2.model.ShiftTradeActivityRule

class ShiftTradeActivityRule extends Object implements Serializable

Serialized Fields

action

ShiftTradeActivityRule.ActionEnum action

activityCategory

ShiftTradeActivityRule.ActivityCategoryEnum activityCategory

activityCodeIdReplacement

String activityCodeIdReplacement

Class com.mypurecloud.sdk.v2.model.ShiftTradeListResponse

class ShiftTradeListResponse extends Object implements Serializable

Serialized Fields

entities

List<ShiftTradeResponse> entities

Class com.mypurecloud.sdk.v2.model.ShiftTradeMatchesSummaryResponse

class ShiftTradeMatchesSummaryResponse extends Object implements Serializable

Serialized Fields

entities

List<WeekShiftTradeMatchesSummaryResponse> entities

Class com.mypurecloud.sdk.v2.model.ShiftTradeMatchReviewResponse

class ShiftTradeMatchReviewResponse extends Object implements Serializable

Serialized Fields

adminReviewViolations

List<ShiftTradeMatchViolation> adminReviewViolations

initiatingUser

ShiftTradeMatchReviewUserResponse initiatingUser

receivingUser

ShiftTradeMatchReviewUserResponse receivingUser

violations

List<ShiftTradeMatchViolation> violations

Class com.mypurecloud.sdk.v2.model.ShiftTradeMatchReviewUserResponse

class ShiftTradeMatchReviewUserResponse extends Object implements Serializable

Serialized Fields

postTradeNewShift

ShiftTradePreviewResponse postTradeNewShift

postTradeSchedulePaidMinutes

Integer postTradeSchedulePaidMinutes

preTradeSchedulePaidMinutes

Integer preTradeSchedulePaidMinutes

weeklyMaximumPaidMinutes

Integer weeklyMaximumPaidMinutes

weeklyMinimumPaidMinutes

Integer weeklyMinimumPaidMinutes

Class com.mypurecloud.sdk.v2.model.ShiftTradeMatchViolation

class ShiftTradeMatchViolation extends Object implements Serializable

Serialized Fields

params

Map<String,String> params

type

ShiftTradeMatchViolation.TypeEnum type

Class com.mypurecloud.sdk.v2.model.ShiftTradeNotification

class ShiftTradeNotification extends Object implements Serializable

Serialized Fields

initiatingShiftDate

Date initiatingShiftDate

initiatingUser

UserReference initiatingUser

newState

ShiftTradeNotification.NewStateEnum newState

oneSided

Boolean oneSided

receivingShiftDate

Date receivingShiftDate

receivingUser

UserReference receivingUser

tradeId

String tradeId

weekDate

String weekDate

Class com.mypurecloud.sdk.v2.model.ShiftTradePreviewResponse

class ShiftTradePreviewResponse extends Object implements Serializable

Serialized Fields

activities

List<ShiftTradeActivityPreviewResponse> activities

Class com.mypurecloud.sdk.v2.model.ShiftTradeResponse

class ShiftTradeResponse extends Object implements Serializable

Serialized Fields

acceptableIntervals

List<String> acceptableIntervals

expiration

Date expiration

id

String id

initiatingShiftEnd

Date initiatingShiftEnd

initiatingShiftId

String initiatingShiftId

initiatingShiftStart

Date initiatingShiftStart

initiatingUser

UserReference initiatingUser

metadata

WfmVersionedEntityMetadata metadata

oneSided

Boolean oneSided

receivingShiftEnd

Date receivingShiftEnd

receivingShiftId

String receivingShiftId

receivingShiftStart

Date receivingShiftStart

receivingUser

UserReference receivingUser

reviewedBy

UserReference reviewedBy

reviewedDate

Date reviewedDate

schedule

BuScheduleReferenceForMuRoute schedule

state

ShiftTradeResponse.StateEnum state

weekDate

LocalDate weekDate

Class com.mypurecloud.sdk.v2.model.ShiftTradeSettings

class ShiftTradeSettings extends Object implements Serializable

Serialized Fields

activityCategoryRules

List<ShiftTradeActivityRule> activityCategoryRules

allowDirectTrades

Boolean allowDirectTrades

autoReview

Boolean autoReview

enabled

Boolean enabled

minHoursInFuture

Integer minHoursInFuture

oneSided

ShiftTradeSettings.OneSidedEnum oneSided

requiresMatchingLanguages

Boolean requiresMatchingLanguages

requiresMatchingPlanningGroups

Boolean requiresMatchingPlanningGroups

requiresMatchingQueues

Boolean requiresMatchingQueues

requiresMatchingSkills

Boolean requiresMatchingSkills

unequalPaid

ShiftTradeSettings.UnequalPaidEnum unequalPaid

weeklyMaxPaidViolations

ShiftTradeSettings.WeeklyMaxPaidViolationsEnum weeklyMaxPaidViolations

weeklyMinPaidViolations

ShiftTradeSettings.WeeklyMinPaidViolationsEnum weeklyMinPaidViolations

Class com.mypurecloud.sdk.v2.model.ShortTermForecastingSettings

class ShortTermForecastingSettings extends Object implements Serializable

Serialized Fields

defaultHistoryWeeks

Integer defaultHistoryWeeks

Class com.mypurecloud.sdk.v2.model.ShortTermForecastReference

class ShortTermForecastReference extends Object implements Serializable

Serialized Fields

description

String description

id

String id

selfUri

String selfUri

weekDate

String weekDate

Class com.mypurecloud.sdk.v2.model.ShrinkageOverride

class ShrinkageOverride extends Object implements Serializable

Serialized Fields

intervalIndex

Integer intervalIndex

shrinkagePercent

Double shrinkagePercent

Class com.mypurecloud.sdk.v2.model.ShrinkageOverrides

class ShrinkageOverrides extends Object implements Serializable

Serialized Fields

clear

Boolean clear

values

List<ShrinkageOverride> values

Class com.mypurecloud.sdk.v2.model.Signature

class Signature extends Object implements Serializable

Serialized Fields

alwaysIncluded

Boolean alwaysIncluded

cannedResponseId

String cannedResponseId

enabled

Boolean enabled

inclusionType

Signature.InclusionTypeEnum inclusionType

Class com.mypurecloud.sdk.v2.model.SignedData

class SignedData extends Object implements Serializable

Serialized Fields

jwt

String jwt

Class com.mypurecloud.sdk.v2.model.SignedUrlResponse

class SignedUrlResponse extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

url

String url

Class com.mypurecloud.sdk.v2.model.SingleWorkdayAveragePoints

class SingleWorkdayAveragePoints extends Object implements Serializable

Serialized Fields

averagePoints

Double averagePoints

dateWorkday

LocalDate dateWorkday

division

Division division

performanceProfile

AddressableEntityRef performanceProfile

Class com.mypurecloud.sdk.v2.model.SingleWorkdayAverageValues

class SingleWorkdayAverageValues extends Object implements Serializable

Serialized Fields

dateWorkday

LocalDate dateWorkday

division

Division division

performanceProfile

AddressableEntityRef performanceProfile

results

List<WorkdayValuesMetricItem> results

timezone

String timezone

user

UserReference user

Class com.mypurecloud.sdk.v2.model.SipDownloadResponse

class SipDownloadResponse extends Object implements Serializable

Serialized Fields

documentId

String documentId

downloadId

String downloadId

Class com.mypurecloud.sdk.v2.model.SIPSearchPublicRequest

class SIPSearchPublicRequest extends Object implements Serializable

Serialized Fields

callId

String callId

conversationId

String conversationId

dateEnd

Date dateEnd

dateStart

Date dateStart

fromUser

String fromUser

id

String id

name

String name

participantId

String participantId

selfUri

String selfUri

toUser

String toUser

Class com.mypurecloud.sdk.v2.model.SipSearchResult

class SipSearchResult extends Object implements Serializable

Serialized Fields

auth

String auth

count

Integer count

data

List<HomerRecord> data

id

String id

message

String message

selfUri

String selfUri

sid

String sid

status

Integer status

Class com.mypurecloud.sdk.v2.model.Site

class Site extends Object implements Serializable

Serialized Fields

addresses

List<Contact> addresses

callerId

String callerId

callerName

String callerName

cloudProxyForceTurn

Boolean cloudProxyForceTurn

coreSite

Boolean coreSite

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

edgeAutoUpdateConfig

EdgeAutoUpdateConfig edgeAutoUpdateConfig

edges

List<Edge> edges

id

String id

location

LocationDefinition location

managed

Boolean managed

mediaModel

Site.MediaModelEnum mediaModel

mediaRegions

List<String> mediaRegions

mediaRegionsUseLatencyBased

Boolean mediaRegionsUseLatencyBased

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

ntpSettings

NTPSettings ntpSettings

primaryEdges

List<Edge> primaryEdges

primarySites

List<DomainEntityRef> primarySites

secondaryEdges

List<Edge> secondaryEdges

secondarySites

List<DomainEntityRef> secondarySites

selfUri

String selfUri

siteConnections

List<SiteConnection> siteConnections

state

Site.StateEnum state

version

Integer version

Class com.mypurecloud.sdk.v2.model.SiteConnection

class SiteConnection extends Object implements Serializable

Serialized Fields

coreSite

Boolean coreSite

edgeList

List<ConnectedEdge> edgeList

enabled

Boolean enabled

id

String id

managed

Boolean managed

mediaModel

SiteConnection.MediaModelEnum mediaModel

name

String name

primaryCoreSites

List<DomainEntityRef> primaryCoreSites

secondaryCoreSites

List<DomainEntityRef> secondaryCoreSites

selfUri

String selfUri

type

SiteConnection.TypeEnum type

Class com.mypurecloud.sdk.v2.model.SiteEntityListing

class SiteEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Site> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.SkillEntityListing

class SkillEntityListing extends Object implements Serializable

Serialized Fields

entities

List<RoutingSkill> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.SkillGroup

class SkillGroup extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

WritableDivision division

id

String id

memberCount

Long memberCount

name

String name

selfUri

String selfUri

skillConditions

List<SkillGroupCondition> skillConditions

Class com.mypurecloud.sdk.v2.model.SkillGroupCondition

class SkillGroupCondition extends Object implements Serializable

Serialized Fields

languageSkillConditions

List<SkillGroupLanguageCondition> languageSkillConditions

operation

SkillGroupCondition.OperationEnum operation

routingSkillConditions

List<SkillGroupRoutingCondition> routingSkillConditions

Class com.mypurecloud.sdk.v2.model.SkillGroupDefinition

class SkillGroupDefinition extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

WritableDivision division

id

String id

memberCount

Long memberCount

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.SkillGroupEntityListing

class SkillGroupEntityListing extends Object implements Serializable

Serialized Fields

entities

List<SkillGroupDefinition> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.SkillGroupLanguageCondition

class SkillGroupLanguageCondition extends Object implements Serializable

Serialized Fields

childConditions

List<SkillGroupCondition> childConditions

comparator

SkillGroupLanguageCondition.ComparatorEnum comparator

languageSkill

String languageSkill

proficiency

Integer proficiency

Class com.mypurecloud.sdk.v2.model.SkillGroupMemberDivisionList

class SkillGroupMemberDivisionList extends Object implements Serializable

Serialized Fields

entities

List<Division> entities

Class com.mypurecloud.sdk.v2.model.SkillGroupMemberDivisions

class SkillGroupMemberDivisions extends Object implements Serializable

Serialized Fields

addDivisionIds

List<String> addDivisionIds

removeDivisionIds

List<String> removeDivisionIds

Class com.mypurecloud.sdk.v2.model.SkillGroupMemberEntityListing

class SkillGroupMemberEntityListing extends Object implements Serializable

Serialized Fields

entities

List<UserReferenceWithName> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.SkillGroupRoutingCondition

class SkillGroupRoutingCondition extends Object implements Serializable

Serialized Fields

childConditions

List<SkillGroupCondition> childConditions

comparator

SkillGroupRoutingCondition.ComparatorEnum comparator

proficiency

Integer proficiency

routingSkill

String routingSkill

Class com.mypurecloud.sdk.v2.model.SkillsToRemove

class SkillsToRemove extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.SmsAddress

class SmsAddress extends Object implements Serializable

Serialized Fields

city

String city

countryCode

String countryCode

id

String id

name

String name

postalCode

String postalCode

region

String region

selfUri

String selfUri

street

String street

validated

Boolean validated

Class com.mypurecloud.sdk.v2.model.SmsAddressEntityListing

class SmsAddressEntityListing extends Object implements Serializable

Serialized Fields

entities

List<SmsAddress> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.SmsAddressProvision

class SmsAddressProvision extends Object implements Serializable

Serialized Fields

autoCorrectAddress

Boolean autoCorrectAddress

city

String city

countryCode

String countryCode

id

String id

name

String name

postalCode

String postalCode

region

String region

selfUri

String selfUri

street

String street

Class com.mypurecloud.sdk.v2.model.SmsAvailablePhoneNumber

class SmsAvailablePhoneNumber extends Object implements Serializable

Serialized Fields

addressRequirement

SmsAvailablePhoneNumber.AddressRequirementEnum addressRequirement

capabilities

List<SmsAvailablePhoneNumber.CapabilitiesEnum> capabilities

city

String city

countryCode

String countryCode

id

String id

name

String name

phoneNumber

String phoneNumber

phoneNumberType

SmsAvailablePhoneNumber.PhoneNumberTypeEnum phoneNumberType

region

String region

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.SMSAvailablePhoneNumberEntityListing

class SMSAvailablePhoneNumberEntityListing extends Object implements Serializable

Serialized Fields

entities

List<SmsAvailablePhoneNumber> entities

Class com.mypurecloud.sdk.v2.model.SmsConfig

class SmsConfig extends Object implements Serializable

Serialized Fields

contentTemplate

DomainEntityRef contentTemplate

messageColumn

String messageColumn

phoneColumn

String phoneColumn

senderSmsPhoneNumber

SmsPhoneNumberRef senderSmsPhoneNumber

Class com.mypurecloud.sdk.v2.model.SmsPhoneNumber

class SmsPhoneNumber extends Object implements Serializable

Serialized Fields

addressId

SmsAddress addressId

autoRenewable

SmsPhoneNumber.AutoRenewableEnum autoRenewable

cancellationDate

Date cancellationDate

capabilities

List<SmsPhoneNumber.CapabilitiesEnum> capabilities

compliance

Compliance compliance

country

String country

countryCode

String countryCode

createdBy

User createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

integration

DomainEntityRef integration

modifiedBy

User modifiedBy

name

String name

phoneNumber

String phoneNumber

phoneNumberStatus

SmsPhoneNumber.PhoneNumberStatusEnum phoneNumberStatus

phoneNumberType

SmsPhoneNumber.PhoneNumberTypeEnum phoneNumberType

provisionedThroughPureCloud

Boolean provisionedThroughPureCloud

provisioningStatus

SmsProvisioningStatus provisioningStatus

purchaseDate

Date purchaseDate

renewalDate

Date renewalDate

selfUri

String selfUri

shortCodeBillingType

SmsPhoneNumber.ShortCodeBillingTypeEnum shortCodeBillingType

supportsMms

Boolean supportsMms

supportsSms

Boolean supportsSms

supportsVoice

Boolean supportsVoice

version

Integer version

Class com.mypurecloud.sdk.v2.model.SmsPhoneNumberEntityListing

class SmsPhoneNumberEntityListing extends Object implements Serializable

Serialized Fields

entities

List<SmsPhoneNumber> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.SmsPhoneNumberImport

class SmsPhoneNumberImport extends Object implements Serializable

Serialized Fields

compliance

Compliance compliance

countryCode

String countryCode

id

String id

integrationId

String integrationId

phoneNumber

String phoneNumber

phoneNumberType

SmsPhoneNumberImport.PhoneNumberTypeEnum phoneNumberType

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.SmsPhoneNumberProvision

class SmsPhoneNumberProvision extends Object implements Serializable

Serialized Fields

addressId

String addressId

countryCode

String countryCode

id

String id

name

String name

phoneNumber

String phoneNumber

phoneNumberType

SmsPhoneNumberProvision.PhoneNumberTypeEnum phoneNumberType

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.SmsPhoneNumberRef

class SmsPhoneNumberRef extends Object implements Serializable

Serialized Fields

phoneNumber

String phoneNumber

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.SmsProvisioningStatus

class SmsProvisioningStatus extends Object implements Serializable

Serialized Fields

action

SmsProvisioningStatus.ActionEnum action

error

ErrorBody error

state

SmsProvisioningStatus.StateEnum state

version

Long version

Class com.mypurecloud.sdk.v2.model.SocialExpression

class SocialExpression extends Object implements Serializable

Serialized Fields

afterCallWork

AfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

connectedTime

Date connectedTime

disconnectedTime

Date disconnectedTime

disconnectType

SocialExpression.DisconnectTypeEnum disconnectType

held

Boolean held

id

String id

peerId

String peerId

previewText

String previewText

provider

String provider

recordingId

String recordingId

scriptId

String scriptId

segments

List<Segment> segments

socialMediaHub

String socialMediaHub

socialMediaId

String socialMediaId

socialUserName

String socialUserName

startAlertingTime

Date startAlertingTime

startHoldTime

Date startHoldTime

state

SocialExpression.StateEnum state

wrapup

Wrapup wrapup

Class com.mypurecloud.sdk.v2.model.SocialHandle

class SocialHandle extends Object implements Serializable

Serialized Fields

type

SocialHandle.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.SortItem

class SortItem extends Object implements Serializable

Serialized Fields

ascending

Boolean ascending

name

String name

Class com.mypurecloud.sdk.v2.model.Source

class Source extends Object implements Serializable

Serialized Fields

deactivated

Boolean deactivated

description

String description

id

String id

name

String name

selfUri

String selfUri

type

Source.TypeEnum type

Class com.mypurecloud.sdk.v2.model.SourceConfiguration

class SourceConfiguration extends Object implements Serializable

Serialized Fields

interactionId

String interactionId

sourceId

String sourceId

tagId

String tagId

Class com.mypurecloud.sdk.v2.model.SourceEntityListing

class SourceEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Source> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.SourcePlanningGroupRequest

class SourcePlanningGroupRequest extends Object implements Serializable

Serialized Fields

id

String id

metadata

WfmVersionedEntityMetadata metadata

Class com.mypurecloud.sdk.v2.model.SpeechTextAnalyticsSettingsRequest

class SpeechTextAnalyticsSettingsRequest extends Object implements Serializable

Serialized Fields

defaultProgramId

String defaultProgramId

expectedDialects

List<String> expectedDialects

Class com.mypurecloud.sdk.v2.model.SpeechTextAnalyticsSettingsResponse

class SpeechTextAnalyticsSettingsResponse extends Object implements Serializable

Serialized Fields

defaultProgram

AddressableEntityRef defaultProgram

expectedDialects

List<String> expectedDialects

Class com.mypurecloud.sdk.v2.model.StarrableDivision

class StarrableDivision extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.StatEventCampaignTopicIntervalMetrics

class StatEventCampaignTopicIntervalMetrics extends Object implements Serializable

Serialized Fields

interval

String interval

metrics

List<StatEventCampaignTopicMetricStats> metrics

Class com.mypurecloud.sdk.v2.model.StatEventCampaignTopicMetricStats

class StatEventCampaignTopicMetricStats extends Object implements Serializable

Serialized Fields

metric

String metric

qualifier

String qualifier

stats

Map<String,BigDecimal> stats

Class com.mypurecloud.sdk.v2.model.StatEventCampaignTopicStatsNotification

class StatEventCampaignTopicStatsNotification extends Object implements Serializable

Serialized Fields

data

List<StatEventCampaignTopicIntervalMetrics> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.StatEventFlowOutcomeTopicIntervalMetrics

class StatEventFlowOutcomeTopicIntervalMetrics extends Object implements Serializable

Serialized Fields

interval

String interval

metrics

List<StatEventFlowOutcomeTopicMetricStats> metrics

Class com.mypurecloud.sdk.v2.model.StatEventFlowOutcomeTopicMetricStats

class StatEventFlowOutcomeTopicMetricStats extends Object implements Serializable

Serialized Fields

metric

String metric

qualifier

String qualifier

stats

Map<String,BigDecimal> stats

Class com.mypurecloud.sdk.v2.model.StatEventFlowOutcomeTopicStatsNotification

class StatEventFlowOutcomeTopicStatsNotification extends Object implements Serializable

Serialized Fields

data

List<StatEventFlowOutcomeTopicIntervalMetrics> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.StatEventFlowTopicIntervalMetrics

class StatEventFlowTopicIntervalMetrics extends Object implements Serializable

Serialized Fields

interval

String interval

metrics

List<StatEventFlowTopicMetricStats> metrics

Class com.mypurecloud.sdk.v2.model.StatEventFlowTopicMetricStats

class StatEventFlowTopicMetricStats extends Object implements Serializable

Serialized Fields

metric

String metric

qualifier

String qualifier

stats

Map<String,BigDecimal> stats

Class com.mypurecloud.sdk.v2.model.StatEventFlowTopicStatsNotification

class StatEventFlowTopicStatsNotification extends Object implements Serializable

Serialized Fields

data

List<StatEventFlowTopicIntervalMetrics> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.StatEventQueueTopicIntervalMetrics

class StatEventQueueTopicIntervalMetrics extends Object implements Serializable

Serialized Fields

interval

String interval

metrics

List<StatEventQueueTopicMetricStats> metrics

Class com.mypurecloud.sdk.v2.model.StatEventQueueTopicMetricStats

class StatEventQueueTopicMetricStats extends Object implements Serializable

Serialized Fields

metric

String metric

qualifier

String qualifier

stats

Map<String,BigDecimal> stats

Class com.mypurecloud.sdk.v2.model.StatEventQueueTopicStatsNotification

class StatEventQueueTopicStatsNotification extends Object implements Serializable

Serialized Fields

data

List<StatEventQueueTopicIntervalMetrics> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.StatEventUserTopicIntervalMetrics

class StatEventUserTopicIntervalMetrics extends Object implements Serializable

Serialized Fields

interval

String interval

metrics

List<StatEventUserTopicMetricStats> metrics

Class com.mypurecloud.sdk.v2.model.StatEventUserTopicMetricStats

class StatEventUserTopicMetricStats extends Object implements Serializable

Serialized Fields

metric

String metric

qualifier

String qualifier

stats

Map<String,BigDecimal> stats

Class com.mypurecloud.sdk.v2.model.StatEventUserTopicStatsNotification

class StatEventUserTopicStatsNotification extends Object implements Serializable

Serialized Fields

data

List<StatEventUserTopicIntervalMetrics> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.StatEventWrapUpCodeTopicIntervalMetrics

class StatEventWrapUpCodeTopicIntervalMetrics extends Object implements Serializable

Serialized Fields

interval

String interval

metrics

List<StatEventWrapUpCodeTopicMetricStats> metrics

Class com.mypurecloud.sdk.v2.model.StatEventWrapUpCodeTopicMetricStats

class StatEventWrapUpCodeTopicMetricStats extends Object implements Serializable

Serialized Fields

metric

String metric

qualifier

String qualifier

stats

Map<String,BigDecimal> stats

Class com.mypurecloud.sdk.v2.model.StatEventWrapUpCodeTopicStatsNotification

class StatEventWrapUpCodeTopicStatsNotification extends Object implements Serializable

Serialized Fields

data

List<StatEventWrapUpCodeTopicIntervalMetrics> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.Station

class Station extends Object implements Serializable

Serialized Fields

description

String description

id

String id

lineAppearanceId

String lineAppearanceId

name

String name

primaryEdge

DomainEntityRef primaryEdge

secondaryEdge

DomainEntityRef secondaryEdge

selfUri

String selfUri

status

Station.StatusEnum status

type

String type

userId

String userId

webRtcCallAppearances

Integer webRtcCallAppearances

webRtcForceTurn

Boolean webRtcForceTurn

webRtcMediaDscp

Integer webRtcMediaDscp

webRtcPersistentEnabled

Boolean webRtcPersistentEnabled

webRtcRequireMediaHelper

Boolean webRtcRequireMediaHelper

webRtcUserId

String webRtcUserId

Class com.mypurecloud.sdk.v2.model.StationEntityListing

class StationEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Station> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.StatisticalResponse

class StatisticalResponse extends Object implements Serializable

Serialized Fields

interval

String interval

metrics

List<AggregateMetricData> metrics

views

List<AggregateViewData> views

Class com.mypurecloud.sdk.v2.model.StatisticalSummary

class StatisticalSummary extends Object implements Serializable

Serialized Fields

count

Long count

countNegative

Long countNegative

countPositive

Long countPositive

current

BigDecimal current

denominator

BigDecimal denominator

max

BigDecimal max

min

BigDecimal min

numerator

BigDecimal numerator

p95

Long p95

p99

Long p99

ratio

BigDecimal ratio

sum

BigDecimal sum

target

BigDecimal target

Class com.mypurecloud.sdk.v2.model.StatusChange

class StatusChange extends Object implements Serializable

Serialized Fields

dateStatusChanged

Date dateStatusChanged

message

String message

namespace

StatusChange.NamespaceEnum namespace

previousStatus

StatusChange.PreviousStatusEnum previousStatus

rejectReason

StatusChange.RejectReasonEnum rejectReason

status

StatusChange.StatusEnum status

Class com.mypurecloud.sdk.v2.model.StopSettings

class StopSettings extends Object implements Serializable

Serialized Fields

keyword

List<String> keyword

response

ComplianceResponse response

Class com.mypurecloud.sdk.v2.model.StorySetting

class StorySetting extends Object implements Serializable

Serialized Fields

mention

InboundOnlySetting mention

reply

InboundOnlySetting reply

Class com.mypurecloud.sdk.v2.model.StreetAddress

class StreetAddress extends Object implements Serializable

Serialized Fields

a1

String a1

a3

String a3

country

String country

HNO

String HNO

LOC

String LOC

NAM

String NAM

PC

String PC

RD

String RD

Class com.mypurecloud.sdk.v2.model.SubjectDivisionGrants

class SubjectDivisionGrants extends Object implements Serializable

Serialized Fields

divisions

List<Division> divisions

id

String id

name

String name

selfUri

String selfUri

type

SubjectDivisionGrants.TypeEnum type

Class com.mypurecloud.sdk.v2.model.SubjectDivisionGrantsEntityListing

class SubjectDivisionGrantsEntityListing extends Object implements Serializable

Serialized Fields

entities

List<SubjectDivisionGrants> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.SubjectDivisions

class SubjectDivisions extends Object implements Serializable

Serialized Fields

divisionIds

List<String> divisionIds

subjectIds

List<String> subjectIds

Class com.mypurecloud.sdk.v2.model.SubscriberResponse

class SubscriberResponse extends Object implements Serializable

Serialized Fields

messageReturned

List<String> messageReturned

status

String status

Class com.mypurecloud.sdk.v2.model.Subscription

class Subscription extends Object implements Serializable

Serialized Fields

id

String id

topic

String topic

Class com.mypurecloud.sdk.v2.model.SubscriptionOverviewUsage

class SubscriptionOverviewUsage extends Object implements Serializable

Serialized Fields

bundleQuantity

String bundleQuantity

grouping

String grouping

isCancellable

Boolean isCancellable

isThirdParty

Boolean isThirdParty

name

String name

overagePrice

String overagePrice

partNumber

String partNumber

prepayPrice

String prepayPrice

prepayQuantity

String prepayQuantity

unitOfMeasureType

String unitOfMeasureType

usageNotes

String usageNotes

usageQuantity

String usageQuantity

Class com.mypurecloud.sdk.v2.model.SuggestSearchCriteria

class SuggestSearchCriteria extends Object implements Serializable

Serialized Fields

dateFormat

String dateFormat

endValue

String endValue

fields

List<String> fields

group

List<SuggestSearchCriteria> group

operator

SuggestSearchCriteria.OperatorEnum operator

startValue

String startValue

value

String value

values

List<String> values

Class com.mypurecloud.sdk.v2.model.SuggestSearchRequest

class SuggestSearchRequest extends Object implements Serializable

Serialized Fields

expand

List<String> expand

query

List<SuggestSearchCriteria> query

types

List<String> types

Class com.mypurecloud.sdk.v2.model.SupportCenterCustomMessage

class SupportCenterCustomMessage extends Object implements Serializable

Serialized Fields

defaultValue

String defaultValue

type

SupportCenterCustomMessage.TypeEnum type

Class com.mypurecloud.sdk.v2.model.SupportCenterFeedbackSettings

class SupportCenterFeedbackSettings extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

Class com.mypurecloud.sdk.v2.model.SupportCenterGlobalStyle

class SupportCenterGlobalStyle extends Object implements Serializable

Serialized Fields

backgroundColor

String backgroundColor

fontFamily

String fontFamily

primaryColor

String primaryColor

primaryColorDark

String primaryColorDark

primaryColorLight

String primaryColorLight

textColor

String textColor

Class com.mypurecloud.sdk.v2.model.SupportCenterHeroStyle

class SupportCenterHeroStyle extends Object implements Serializable

Serialized Fields

backgroundColor

String backgroundColor

textColor

String textColor

Class com.mypurecloud.sdk.v2.model.SupportCenterModuleSetting

class SupportCenterModuleSetting extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

type

SupportCenterModuleSetting.TypeEnum type

Class com.mypurecloud.sdk.v2.model.SupportCenterScreen

class SupportCenterScreen extends Object implements Serializable

Serialized Fields

moduleSettings

List<SupportCenterModuleSetting> moduleSettings

type

SupportCenterScreen.TypeEnum type

Class com.mypurecloud.sdk.v2.model.SupportCenterSettings

class SupportCenterSettings extends Object implements Serializable

Serialized Fields

customMessages

List<SupportCenterCustomMessage> customMessages

enabled

Boolean enabled

enabledCategories

List<AddressableEntityRef> enabledCategories

feedback

SupportCenterFeedbackSettings feedback

knowledgeBase

AddressableEntityRef knowledgeBase

routerType

SupportCenterSettings.RouterTypeEnum routerType

screens

List<SupportCenterScreen> screens

styleSetting

SupportCenterStyleSetting styleSetting

Class com.mypurecloud.sdk.v2.model.SupportCenterStyleSetting

class SupportCenterStyleSetting extends Object implements Serializable

Serialized Fields

globalStyle

SupportCenterGlobalStyle globalStyle

heroStyle

SupportCenterHeroStyle heroStyle

Class com.mypurecloud.sdk.v2.model.SupportedContent

class SupportedContent extends Object implements Serializable

Serialized Fields

createdBy

DomainEntityRef createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

mediaTypes

MediaTypes mediaTypes

modifiedBy

DomainEntityRef modifiedBy

name

String name

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.SupportedContentListing

class SupportedContentListing extends Object implements Serializable

Serialized Fields

entities

List<SupportedContent> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.SupportedContentProfile

class SupportedContentProfile extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.SupportedContentReference

class SupportedContentReference extends Object implements Serializable

Serialized Fields

id

String id

mediaTypes

MediaTypes mediaTypes

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.SupportedDialectsEntityListing

class SupportedDialectsEntityListing extends Object implements Serializable

Serialized Fields

entities

List<TranscriptionEngines> entities

Class com.mypurecloud.sdk.v2.model.SupportedLanguage

class SupportedLanguage extends Object implements Serializable

Serialized Fields

isDefault

Boolean isDefault

language

String language

Class com.mypurecloud.sdk.v2.model.Survey

class Survey extends Object implements Serializable

Serialized Fields

agent

DomainEntityRef agent

answers

SurveyScoringSet answers

completedDate

Date completedDate

conversation

ConversationReference conversation

id

String id

name

String name

queue

QueueReference queue

selfUri

String selfUri

status

Survey.StatusEnum status

surveyErrorDetails

SurveyErrorDetails surveyErrorDetails

surveyForm

SurveyForm surveyForm

Class com.mypurecloud.sdk.v2.model.SurveyAggregateDataContainer

class SurveyAggregateDataContainer extends Object implements Serializable

Serialized Fields

data

List<StatisticalResponse> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.SurveyAggregateQueryClause

class SurveyAggregateQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<SurveyAggregateQueryPredicate> predicates

type

SurveyAggregateQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.SurveyAggregateQueryFilter

class SurveyAggregateQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<SurveyAggregateQueryClause> clauses

predicates

List<SurveyAggregateQueryPredicate> predicates

type

SurveyAggregateQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.SurveyAggregateQueryPredicate

class SurveyAggregateQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

SurveyAggregateQueryPredicate.DimensionEnum dimension

operator

SurveyAggregateQueryPredicate.OperatorEnum operator

range

NumericRange range

type

SurveyAggregateQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.SurveyAggregateQueryResponse

class SurveyAggregateQueryResponse extends Object implements Serializable

Serialized Fields

results

List<SurveyAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.SurveyAggregationQuery

class SurveyAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

SurveyAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

SurveyAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<SurveyAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<SurveyAggregationQuery.MetricsEnum> metrics

timeZone

String timeZone

views

List<SurveyAggregationView> views

Class com.mypurecloud.sdk.v2.model.SurveyAggregationView

class SurveyAggregationView extends Object implements Serializable

Serialized Fields

function

SurveyAggregationView.FunctionEnum function

name

String name

range

AggregationRange range

target

SurveyAggregationView.TargetEnum target

Class com.mypurecloud.sdk.v2.model.SurveyAssignment

class SurveyAssignment extends Object implements Serializable

Serialized Fields

flow

DomainEntityRef flow

inviteTimeInterval

String inviteTimeInterval

sendingDomain

String sendingDomain

sendingUser

String sendingUser

surveyForm

PublishedSurveyFormReference surveyForm

Class com.mypurecloud.sdk.v2.model.SurveyAsyncAggregateQueryResponse

class SurveyAsyncAggregateQueryResponse extends Object implements Serializable

Serialized Fields

cursor

String cursor

results

List<SurveyAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.SurveyAsyncAggregationQuery

class SurveyAsyncAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

SurveyAsyncAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

SurveyAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<SurveyAsyncAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<SurveyAsyncAggregationQuery.MetricsEnum> metrics

pageSize

Integer pageSize

timeZone

String timeZone

views

List<SurveyAggregationView> views

Class com.mypurecloud.sdk.v2.model.SurveyDetailQueryClause

class SurveyDetailQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<SurveyDetailQueryPredicate> predicates

type

SurveyDetailQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.SurveyDetailQueryFilter

class SurveyDetailQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<SurveyDetailQueryClause> clauses

predicates

List<SurveyDetailQueryPredicate> predicates

type

SurveyDetailQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.SurveyDetailQueryPredicate

class SurveyDetailQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

SurveyDetailQueryPredicate.DimensionEnum dimension

metric

SurveyDetailQueryPredicate.MetricEnum metric

operator

SurveyDetailQueryPredicate.OperatorEnum operator

range

NumericRange range

type

SurveyDetailQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.SurveyErrorDetails

class SurveyErrorDetails extends Object implements Serializable

Serialized Fields

flowDiagnosticInfo

FlowDiagnosticInfo flowDiagnosticInfo

surveyErrorReason

String surveyErrorReason

Class com.mypurecloud.sdk.v2.model.SurveyForm

class SurveyForm extends Object implements Serializable

Serialized Fields

contextId

String contextId

disabled

Boolean disabled

footer

String footer

header

String header

id

String id

language

String language

modifiedDate

Date modifiedDate

name

String name

published

Boolean published

publishedVersions

DomainEntityListingSurveyForm publishedVersions

questionGroups

List<SurveyQuestionGroup> questionGroups

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.SurveyFormAndScoringSet

class SurveyFormAndScoringSet extends Object implements Serializable

Serialized Fields

answers

SurveyScoringSet answers

surveyForm

SurveyForm surveyForm

Class com.mypurecloud.sdk.v2.model.SurveyFormEntityListing

class SurveyFormEntityListing extends Object implements Serializable

Serialized Fields

entities

List<SurveyForm> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.SurveyQuestion

class SurveyQuestion extends Object implements Serializable

Serialized Fields

answerOptions

List<AnswerOption> answerOptions

explanationPrompt

String explanationPrompt

helpText

String helpText

id

String id

maxResponseCharacters

Integer maxResponseCharacters

naEnabled

Boolean naEnabled

text

String text

type

SurveyQuestion.TypeEnum type

visibilityCondition

VisibilityCondition visibilityCondition

Class com.mypurecloud.sdk.v2.model.SurveyQuestionGroup

class SurveyQuestionGroup extends Object implements Serializable

Serialized Fields

id

String id

naEnabled

Boolean naEnabled

name

String name

questions

List<SurveyQuestion> questions

type

String type

visibilityCondition

VisibilityCondition visibilityCondition

Class com.mypurecloud.sdk.v2.model.SurveyQuestionGroupScore

class SurveyQuestionGroupScore extends Object implements Serializable

Serialized Fields

markedNA

Boolean markedNA

maxTotalScore

Float maxTotalScore

questionGroupId

String questionGroupId

questionScores

List<SurveyQuestionScore> questionScores

totalScore

Float totalScore

Class com.mypurecloud.sdk.v2.model.SurveyQuestionScore

class SurveyQuestionScore extends Object implements Serializable

Serialized Fields

answerId

String answerId

assistedAnswerId

String assistedAnswerId

freeTextAnswer

String freeTextAnswer

markedNA

Boolean markedNA

npsScore

Integer npsScore

npsTextAnswer

String npsTextAnswer

questionId

String questionId

score

Integer score

Class com.mypurecloud.sdk.v2.model.SurveyScoringSet

class SurveyScoringSet extends Object implements Serializable

Serialized Fields

npsScore

Integer npsScore

questionGroupScores

List<SurveyQuestionGroupScore> questionGroupScores

totalScore

Float totalScore

Class com.mypurecloud.sdk.v2.model.SystemMessageObject

class SystemMessageObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.SystemMessageSystemMessage

class SystemMessageSystemMessage extends Object implements Serializable

Serialized Fields

channelId

String channelId

correlationId

String correlationId

data

Map<String,Object> data

message

String message

oauthClientId

String oauthClientId

organizationId

String organizationId

reason

SystemMessageSystemMessage.ReasonEnum reason

systemTopicType

SystemMessageSystemMessage.SystemTopicTypeEnum systemTopicType

userId

String userId

Class com.mypurecloud.sdk.v2.model.SystemPresence

class SystemPresence extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.SystemPrompt

class SystemPrompt extends Object implements Serializable

Serialized Fields

description

String description

id

String id

name

String name

resources

List<SystemPromptAsset> resources

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.SystemPromptAsset

class SystemPromptAsset extends Object implements Serializable

Serialized Fields

durationSeconds

Double durationSeconds

hasDefault

Boolean hasDefault

id

String id

language

String language

languageDefault

Boolean languageDefault

mediaUri

String mediaUri

name

String name

promptId

String promptId

selfUri

String selfUri

tags

Map<String,List<String>> tags

text

String text

ttsString

String ttsString

uploadStatus

SystemPromptAsset.UploadStatusEnum uploadStatus

uploadUri

String uploadUri

Class com.mypurecloud.sdk.v2.model.SystemPromptAssetEntityListing

class SystemPromptAssetEntityListing extends Object implements Serializable

Serialized Fields

entities

List<SystemPromptAsset> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.SystemPromptEntityListing

class SystemPromptEntityListing extends Object implements Serializable

Serialized Fields

entities

List<SystemPrompt> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.TagQueryRequest

class TagQueryRequest extends Object implements Serializable

Serialized Fields

pageNumber

Integer pageNumber

pageSize

Integer pageSize

query

String query

Class com.mypurecloud.sdk.v2.model.TagValue

class TagValue extends Object implements Serializable

Serialized Fields

acl

List<String> acl

id

String id

inUse

Boolean inUse

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.TagValueEntityListing

class TagValueEntityListing extends Object implements Serializable

Serialized Fields

entities

List<TagValue> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.TargetPerformanceProfile

class TargetPerformanceProfile extends Object implements Serializable

Serialized Fields

targetPerformanceProfileId

String targetPerformanceProfileId

Class com.mypurecloud.sdk.v2.model.TaskManagementAggregateDataContainer

class TaskManagementAggregateDataContainer extends Object implements Serializable

Serialized Fields

data

List<StatisticalResponse> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.TaskManagementAggregateQueryClause

class TaskManagementAggregateQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<TaskManagementAggregateQueryPredicate> predicates

type

TaskManagementAggregateQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.TaskManagementAggregateQueryFilter

class TaskManagementAggregateQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<TaskManagementAggregateQueryClause> clauses

predicates

List<TaskManagementAggregateQueryPredicate> predicates

type

TaskManagementAggregateQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.TaskManagementAggregateQueryPredicate

class TaskManagementAggregateQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

TaskManagementAggregateQueryPredicate.DimensionEnum dimension

operator

TaskManagementAggregateQueryPredicate.OperatorEnum operator

range

NumericRange range

type

TaskManagementAggregateQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.TaskManagementAggregateQueryResponse

class TaskManagementAggregateQueryResponse extends Object implements Serializable

Serialized Fields

results

List<TaskManagementAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.TaskManagementAggregationQuery

class TaskManagementAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

TaskManagementAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

TaskManagementAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<TaskManagementAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<TaskManagementAggregationQuery.MetricsEnum> metrics

timeZone

String timeZone

views

List<TaskManagementAggregationView> views

Class com.mypurecloud.sdk.v2.model.TaskManagementAggregationView

class TaskManagementAggregationView extends Object implements Serializable

Serialized Fields

function

TaskManagementAggregationView.FunctionEnum function

name

String name

range

AggregationRange range

target

TaskManagementAggregationView.TargetEnum target

Class com.mypurecloud.sdk.v2.model.TaskManagementAsyncAggregateQueryResponse

class TaskManagementAsyncAggregateQueryResponse extends Object implements Serializable

Serialized Fields

cursor

String cursor

results

List<TaskManagementAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.TaskManagementAsyncAggregationQuery

class TaskManagementAsyncAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

TaskManagementAsyncAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

TaskManagementAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<TaskManagementAsyncAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<TaskManagementAsyncAggregationQuery.MetricsEnum> metrics

pageSize

Integer pageSize

timeZone

String timeZone

views

List<TaskManagementAggregationView> views

Class com.mypurecloud.sdk.v2.model.Team

class Team extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

WritableDivision division

id

String id

memberCount

Long memberCount

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.TeamActivityData

class TeamActivityData extends Object implements Serializable

Serialized Fields

data

List<TeamActivityMetricValue> data

entities

List<TeamActivityEntityData> entities

group

Map<String,String> group

truncated

Boolean truncated

Class com.mypurecloud.sdk.v2.model.TeamActivityEntityData

class TeamActivityEntityData extends Object implements Serializable

Serialized Fields

activityDate

Date activityDate

organizationPresenceId

String organizationPresenceId

presenceDate

Date presenceDate

queueId

String queueId

queueMembershipStatus

String queueMembershipStatus

routingStatus

String routingStatus

routingStatusDate

Date routingStatusDate

systemPresence

String systemPresence

teamId

String teamId

userId

String userId

Class com.mypurecloud.sdk.v2.model.TeamActivityMetricValue

class TeamActivityMetricValue extends Object implements Serializable

Serialized Fields

count

Integer count

metric

TeamActivityMetricValue.MetricEnum metric

Class com.mypurecloud.sdk.v2.model.TeamActivityQuery

class TeamActivityQuery extends Object implements Serializable

Serialized Fields

filter

TeamActivityQueryFilter filter

groupBy

List<TeamActivityQuery.GroupByEnum> groupBy

metrics

List<TeamActivityQueryMetric> metrics

order

TeamActivityQuery.OrderEnum order

Class com.mypurecloud.sdk.v2.model.TeamActivityQueryClause

class TeamActivityQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<TeamActivityQueryPredicate> predicates

type

TeamActivityQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.TeamActivityQueryFilter

class TeamActivityQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<TeamActivityQueryClause> clauses

predicates

List<TeamActivityQueryPredicate> predicates

type

TeamActivityQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.TeamActivityQueryMetric

class TeamActivityQueryMetric extends Object implements Serializable

Serialized Fields

details

Boolean details

metric

TeamActivityQueryMetric.MetricEnum metric

Class com.mypurecloud.sdk.v2.model.TeamActivityQueryPredicate

class TeamActivityQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

TeamActivityQueryPredicate.DimensionEnum dimension

operator

TeamActivityQueryPredicate.OperatorEnum operator

type

TeamActivityQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.TeamActivityResponse

class TeamActivityResponse extends Object implements Serializable

Serialized Fields

entityIdDimension

TeamActivityResponse.EntityIdDimensionEnum entityIdDimension

results

List<TeamActivityData> results

Class com.mypurecloud.sdk.v2.model.TeamAddMemberFailure

class TeamAddMemberFailure extends Object implements Serializable

Serialized Fields

id

String id

reason

TeamAddMemberFailure.ReasonEnum reason

Class com.mypurecloud.sdk.v2.model.TeamEntityListing

class TeamEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Team> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.TeamMemberAddListingResponse

class TeamMemberAddListingResponse extends Object implements Serializable

Serialized Fields

entities

List<UserReference> entities

failures

List<TeamAddMemberFailure> failures

Class com.mypurecloud.sdk.v2.model.TeamMemberEntityListing

class TeamMemberEntityListing extends Object implements Serializable

Serialized Fields

entities

List<UserReferenceWithName> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.TeamMembers

class TeamMembers extends Object implements Serializable

Serialized Fields

memberIds

List<String> memberIds

Class com.mypurecloud.sdk.v2.model.TeamReference

class TeamReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.TeamSearchCriteria

class TeamSearchCriteria extends Object implements Serializable

Serialized Fields

dateFormat

String dateFormat

endValue

String endValue

fields

List<String> fields

group

List<TeamSearchCriteria> group

operator

TeamSearchCriteria.OperatorEnum operator

startValue

String startValue

type

TeamSearchCriteria.TypeEnum type

value

String value

values

List<String> values

Class com.mypurecloud.sdk.v2.model.TeamSearchRequest

class TeamSearchRequest extends Object implements Serializable

Serialized Fields

pageNumber

Integer pageNumber

pageSize

Integer pageSize

query

List<TeamSearchCriteria> query

sort

List<SearchSort> sort

sortBy

String sortBy

sortOrder

TeamSearchRequest.SortOrderEnum sortOrder

Class com.mypurecloud.sdk.v2.model.TeamsSearchResponse

class TeamsSearchResponse extends Object implements Serializable

Serialized Fields

currentPage

String currentPage

nextPage

String nextPage

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousPage

String previousPage

results

List<Team> results

total

Long total

types

List<String> types

Class com.mypurecloud.sdk.v2.model.TemplateParameter

class TemplateParameter extends Object implements Serializable

Serialized Fields

id

String id

value

String value

Class com.mypurecloud.sdk.v2.model.TermAttribute

class TermAttribute extends Object implements Serializable

Serialized Fields

id

String id

name

String name

type

TermAttribute.TypeEnum type

Class com.mypurecloud.sdk.v2.model.TestExecutionOperationResult

class TestExecutionOperationResult extends Object implements Serializable

Serialized Fields

error

ErrorBody error

name

String name

result

Object result

step

Integer step

success

Boolean success

Class com.mypurecloud.sdk.v2.model.TestExecutionResult

class TestExecutionResult extends Object implements Serializable

Serialized Fields

error

ErrorBody error

finalResult

Object finalResult

operations

List<TestExecutionOperationResult> operations

success

Boolean success

Class com.mypurecloud.sdk.v2.model.TestMatchesEventOperation

class TestMatchesEventOperation extends Object implements Serializable

Serialized Fields

matchedTriggers

List<TestModeTrigger> matchedTriggers

name

String name

step

Integer step

unmatchedTriggers

List<TestModeTrigger> unmatchedTriggers

Class com.mypurecloud.sdk.v2.model.TestMatchesOperation

class TestMatchesOperation extends Object implements Serializable

Serialized Fields

details

List<MatchCriteriaTestResult> details

matches

Boolean matches

name

String name

step

Integer step

Class com.mypurecloud.sdk.v2.model.TestMessage

class TestMessage extends Object implements Serializable

Serialized Fields

from

EmailAddress from

htmlBody

String htmlBody

id

String id

subject

String subject

textBody

String textBody

time

Date time

to

List<EmailAddress> to

Class com.mypurecloud.sdk.v2.model.TestModeEventResults

class TestModeEventResults extends Object implements Serializable

Serialized Fields

schemaValidation

TestSchemaOperation schemaValidation

triggerMatchValidation

TestMatchesEventOperation triggerMatchValidation

Class com.mypurecloud.sdk.v2.model.TestModeResults

class TestModeResults extends Object implements Serializable

Serialized Fields

jsonPathValidation

TestMatchesOperation jsonPathValidation

schemaValidation

TestSchemaOperation schemaValidation

targetValidation

TestTargetOperation targetValidation

triggerMatches

Boolean triggerMatches

Class com.mypurecloud.sdk.v2.model.TestModeTrigger

class TestModeTrigger extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.TestSchemaOperation

class TestSchemaOperation extends Object implements Serializable

Serialized Fields

details

List<String> details

matches

Boolean matches

name

String name

step

Integer step

Class com.mypurecloud.sdk.v2.model.TestTargetOperation

class TestTargetOperation extends Object implements Serializable

Serialized Fields

details

List<String> details

matches

Boolean matches

name

String name

step

Integer step

Class com.mypurecloud.sdk.v2.model.TextBotChannel

class TextBotChannel extends Object implements Serializable

Serialized Fields

inputModes

List<TextBotChannel.InputModesEnum> inputModes

name

TextBotChannel.NameEnum name

outputModes

List<TextBotChannel.OutputModesEnum> outputModes

userAgent

TextBotUserAgent userAgent

Class com.mypurecloud.sdk.v2.model.TextBotDisconnectAction

class TextBotDisconnectAction extends Object implements Serializable

Serialized Fields

flowLocation

TextBotFlowLocation flowLocation

flowOutcomes

List<TextBotFlowOutcome> flowOutcomes

reason

TextBotDisconnectAction.ReasonEnum reason

reasonExtendedInfo

String reasonExtendedInfo

Class com.mypurecloud.sdk.v2.model.TextBotErrorInputEvent

class TextBotErrorInputEvent extends Object implements Serializable

Serialized Fields

code

String code

message

String message

Class com.mypurecloud.sdk.v2.model.TextBotExitAction

class TextBotExitAction extends Object implements Serializable

Serialized Fields

activeIntent

String activeIntent

flowLocation

TextBotFlowLocation flowLocation

flowOutcomes

List<TextBotFlowOutcome> flowOutcomes

outputData

TextBotInputOutputData outputData

reason

TextBotExitAction.ReasonEnum reason

reasonExtendedInfo

String reasonExtendedInfo

Class com.mypurecloud.sdk.v2.model.TextBotFlow

class TextBotFlow extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.TextBotFlowLaunchRequest

class TextBotFlowLaunchRequest extends Object implements Serializable

Serialized Fields

channel

TextBotChannel channel

conversationId

String conversationId

externalSessionId

String externalSessionId

flow

TextBotFlow flow

inputData

TextBotInputOutputData inputData

language

String language

Class com.mypurecloud.sdk.v2.model.TextBotFlowLaunchResponse

class TextBotFlowLaunchResponse extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.TextBotFlowLocation

class TextBotFlowLocation extends Object implements Serializable

Serialized Fields

actionName

String actionName

actionNumber

Integer actionNumber

sequenceName

String sequenceName

Class com.mypurecloud.sdk.v2.model.TextBotFlowMilestone

class TextBotFlowMilestone extends Object implements Serializable

Serialized Fields

dateReached

Date dateReached

id

String id

sequence

Long sequence

Class com.mypurecloud.sdk.v2.model.TextBotFlowOutcome

class TextBotFlowOutcome extends Object implements Serializable

Serialized Fields

dateEnd

Date dateEnd

dateStart

Date dateStart

milestones

List<TextBotFlowMilestone> milestones

outcomeId

String outcomeId

outcomeValue

TextBotFlowOutcome.OutcomeValueEnum outcomeValue

Class com.mypurecloud.sdk.v2.model.TextBotFlowTurnRequest

class TextBotFlowTurnRequest extends Object implements Serializable

Serialized Fields

inputEventError

TextBotErrorInputEvent inputEventError

inputEventType

TextBotFlowTurnRequest.InputEventTypeEnum inputEventType

inputEventUserInput

TextBotUserInputEvent inputEventUserInput

previousTurn

TextBotTurnReference previousTurn

Class com.mypurecloud.sdk.v2.model.TextBotFlowTurnResponse

class TextBotFlowTurnResponse extends Object implements Serializable

Serialized Fields

id

String id

nextActionDisconnect

TextBotDisconnectAction nextActionDisconnect

nextActionExit

TextBotExitAction nextActionExit

nextActionType

TextBotFlowTurnResponse.NextActionTypeEnum nextActionType

nextActionWaitForInput

TextBotWaitForInputAction nextActionWaitForInput

previousTurn

TextBotTurnReference previousTurn

prompts

TextBotOutputPrompts prompts

Class com.mypurecloud.sdk.v2.model.TextBotInputOutputData

class TextBotInputOutputData extends Object implements Serializable

Serialized Fields

variables

Map<String,Object> variables

Class com.mypurecloud.sdk.v2.model.TextBotModeConstraints

class TextBotModeConstraints extends Object implements Serializable

Serialized Fields

text

TextBotTextModeConstraints text

Class com.mypurecloud.sdk.v2.model.TextBotModeOutputPrompts

class TextBotModeOutputPrompts extends Object implements Serializable

Serialized Fields

segments

List<TextBotPromptSegment> segments

Class com.mypurecloud.sdk.v2.model.TextBotOutputPrompts

class TextBotOutputPrompts extends Object implements Serializable

Serialized Fields

outputLanguage

String outputLanguage

textPrompts

TextBotModeOutputPrompts textPrompts

Class com.mypurecloud.sdk.v2.model.TextBotPromptSegment

class TextBotPromptSegment extends Object implements Serializable

Serialized Fields

content

List<MessageContent> content

format

Format format

text

String text

type

TextBotPromptSegment.TypeEnum type

Class com.mypurecloud.sdk.v2.model.TextBotTextModeConstraints

class TextBotTextModeConstraints extends Object implements Serializable

Serialized Fields

languagePreferences

List<String> languagePreferences

noInputTimeoutMilliseconds

Integer noInputTimeoutMilliseconds

Class com.mypurecloud.sdk.v2.model.TextBotTranscript

class TextBotTranscript extends Object implements Serializable

Serialized Fields

confidence

Float confidence

text

String text

Class com.mypurecloud.sdk.v2.model.TextBotTurnReference

class TextBotTurnReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.TextBotUserAgent

class TextBotUserAgent extends Object implements Serializable

Serialized Fields

name

TextBotUserAgent.NameEnum name

Class com.mypurecloud.sdk.v2.model.TextBotUserInputAlternative

class TextBotUserInputAlternative extends Object implements Serializable

Serialized Fields

transcript

TextBotTranscript transcript

Class com.mypurecloud.sdk.v2.model.TextBotUserInputEvent

class TextBotUserInputEvent extends Object implements Serializable

Serialized Fields

alternatives

List<TextBotUserInputAlternative> alternatives

mode

TextBotUserInputEvent.ModeEnum mode

Class com.mypurecloud.sdk.v2.model.TextBotWaitForInputAction

class TextBotWaitForInputAction extends Object implements Serializable

Serialized Fields

modeConstraints

TextBotModeConstraints modeConstraints

Class com.mypurecloud.sdk.v2.model.TextMessageListing

class TextMessageListing extends Object implements Serializable

Serialized Fields

entities

List<MessageData> entities

Class com.mypurecloud.sdk.v2.model.TextStyleProperties

class TextStyleProperties extends Object implements Serializable

Serialized Fields

color

String color

font

String font

fontSize

String fontSize

textAlign

TextStyleProperties.TextAlignEnum textAlign

Class com.mypurecloud.sdk.v2.model.Ticker

class Ticker extends Object implements Serializable

Serialized Fields

exchange

String exchange

symbol

String symbol

Class com.mypurecloud.sdk.v2.model.TimeAllowed

class TimeAllowed extends Object implements Serializable

Serialized Fields

empty

Boolean empty

timeSlots

List<TimeSlot> timeSlots

timeZoneId

String timeZoneId

Class com.mypurecloud.sdk.v2.model.TimeInterval

class TimeInterval extends Object implements Serializable

Serialized Fields

days

Integer days

hours

Integer hours

months

Integer months

weeks

Integer weeks

Class com.mypurecloud.sdk.v2.model.TimeOffBalanceJobReference

class TimeOffBalanceJobReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

status

TimeOffBalanceJobReference.StatusEnum status

Class com.mypurecloud.sdk.v2.model.TimeOffBalanceRequest

class TimeOffBalanceRequest extends Object implements Serializable

Serialized Fields

activityCodeIds

List<String> activityCodeIds

dateRanges

List<LocalDateRange> dateRanges

Class com.mypurecloud.sdk.v2.model.TimeOffBalanceResponse

class TimeOffBalanceResponse extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

balanceMinutesPerDay

List<Integer> balanceMinutesPerDay

hrisTimeOffTypeId

String hrisTimeOffTypeId

hrisTimeOffTypeSecondaryId

String hrisTimeOffTypeSecondaryId

startDate

LocalDate startDate

Class com.mypurecloud.sdk.v2.model.TimeOffBalancesResponse

class TimeOffBalancesResponse extends Object implements Serializable

Serialized Fields

entities

List<TimeOffBalanceResponse> entities

job

TimeOffBalanceJobReference job

Class com.mypurecloud.sdk.v2.model.TimeOffLimit

class TimeOffLimit extends Object implements Serializable

Serialized Fields

defaultLimitMinutes

Integer defaultLimitMinutes

granularity

TimeOffLimit.GranularityEnum granularity

id

String id

metadata

WfmVersionedEntityMetadata metadata

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.TimeOffLimitListing

class TimeOffLimitListing extends Object implements Serializable

Serialized Fields

entities

List<TimeOffLimit> entities

Class com.mypurecloud.sdk.v2.model.TimeOffLimitRange

class TimeOffLimitRange extends Object implements Serializable

Serialized Fields

granularity

TimeOffLimitRange.GranularityEnum granularity

limitMinutesPerInterval

List<Integer> limitMinutesPerInterval

startDate

LocalDate startDate

Class com.mypurecloud.sdk.v2.model.TimeOffLimitReference

class TimeOffLimitReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.TimeOffLimitValueRange

class TimeOffLimitValueRange extends Object implements Serializable

Serialized Fields

allocatedMinutesPerInterval

List<Integer> allocatedMinutesPerInterval

granularity

TimeOffLimitValueRange.GranularityEnum granularity

limitMinutesPerInterval

List<Integer> limitMinutesPerInterval

metadata

WfmVersionedEntityMetadata metadata

startDate

LocalDate startDate

timeOffLimit

TimeOffLimitReference timeOffLimit

waitlistedMinutesPerInterval

List<Integer> waitlistedMinutesPerInterval

waitlistedRequestsPerInterval

List<Integer> waitlistedRequestsPerInterval

Class com.mypurecloud.sdk.v2.model.TimeOffPlan

class TimeOffPlan extends Object implements Serializable

Serialized Fields

active

Boolean active

activityCodeIds

List<String> activityCodeIds

autoApprovalRule

TimeOffPlan.AutoApprovalRuleEnum autoApprovalRule

daysBeforeStartToExpireFromWaitlist

Integer daysBeforeStartToExpireFromWaitlist

id

String id

metadata

WfmVersionedEntityMetadata metadata

name

String name

selfUri

String selfUri

timeOffLimits

List<TimeOffLimitReference> timeOffLimits

Class com.mypurecloud.sdk.v2.model.TimeOffPlanListing

class TimeOffPlanListing extends Object implements Serializable

Serialized Fields

entities

List<TimeOffPlan> entities

Class com.mypurecloud.sdk.v2.model.TimeOffRequest

class TimeOffRequest extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

dailyDurationMinutes

Integer dailyDurationMinutes

fullDayManagementUnitDates

List<String> fullDayManagementUnitDates

id

String id

isFullDayRequest

Boolean isFullDayRequest

markedAsRead

Boolean markedAsRead

metadata

WfmVersionedEntityMetadata metadata

notes

String notes

paid

Boolean paid

partialDayStartDateTimes

List<Date> partialDayStartDateTimes

reviewedBy

UserReference reviewedBy

reviewedDate

Date reviewedDate

selfUri

String selfUri

status

TimeOffRequest.StatusEnum status

submittedBy

UserReference submittedBy

submittedDate

Date submittedDate

substatus

TimeOffRequest.SubstatusEnum substatus

user

UserReference user

Class com.mypurecloud.sdk.v2.model.TimeOffRequestList

class TimeOffRequestList extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

timeOffRequests

List<TimeOffRequestResponse> timeOffRequests

Class com.mypurecloud.sdk.v2.model.TimeOffRequestListing

class TimeOffRequestListing extends Object implements Serializable

Serialized Fields

entities

List<TimeOffRequest> entities

Class com.mypurecloud.sdk.v2.model.TimeOffRequestNotification

class TimeOffRequestNotification extends Object implements Serializable

Serialized Fields

fullDayManagementUnitDates

List<String> fullDayManagementUnitDates

isFullDayRequest

Boolean isFullDayRequest

partialDayStartDateTimes

List<Date> partialDayStartDateTimes

status

TimeOffRequestNotification.StatusEnum status

timeOffRequestId

String timeOffRequestId

user

UserReference user

Class com.mypurecloud.sdk.v2.model.TimeOffRequestQueryBody

class TimeOffRequestQueryBody extends Object implements Serializable

Serialized Fields

dateRange

DateRange dateRange

ids

List<String> ids

statuses

List<TimeOffRequestQueryBody.StatusesEnum> statuses

substatuses

List<TimeOffRequestQueryBody.SubstatusesEnum> substatuses

userIds

List<String> userIds

Class com.mypurecloud.sdk.v2.model.TimeOffRequestReference

class TimeOffRequestReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.TimeOffRequestResponse

class TimeOffRequestResponse extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

dailyDurationMinutes

Integer dailyDurationMinutes

fullDayManagementUnitDates

List<String> fullDayManagementUnitDates

id

String id

isFullDayRequest

Boolean isFullDayRequest

markedAsRead

Boolean markedAsRead

metadata

WfmVersionedEntityMetadata metadata

modifiedBy

UserReference modifiedBy

modifiedDate

Date modifiedDate

notes

String notes

paid

Boolean paid

partialDayStartDateTimes

List<Date> partialDayStartDateTimes

reviewedBy

UserReference reviewedBy

reviewedDate

Date reviewedDate

selfUri

String selfUri

status

TimeOffRequestResponse.StatusEnum status

submittedBy

UserReference submittedBy

submittedDate

Date submittedDate

substatus

TimeOffRequestResponse.SubstatusEnum substatus

user

UserReference user

Class com.mypurecloud.sdk.v2.model.TimeOffRequestSettings

class TimeOffRequestSettings extends Object implements Serializable

Serialized Fields

submissionEarliestDaysFromNow

Integer submissionEarliestDaysFromNow

submissionLatestDaysFromNow

Integer submissionLatestDaysFromNow

submissionRangeEnforced

Boolean submissionRangeEnforced

Class com.mypurecloud.sdk.v2.model.TimeSlot

class TimeSlot extends Object implements Serializable

Serialized Fields

day

Integer day

startTime

String startTime

stopTime

String stopTime

Class com.mypurecloud.sdk.v2.model.TimeZoneEntityListing

class TimeZoneEntityListing extends Object implements Serializable

Serialized Fields

entities

List<RegionTimeZone> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.TimeZoneMappingPreview

class TimeZoneMappingPreview extends Object implements Serializable

Serialized Fields

contactList

DomainEntityRef contactList

contactListSize

Long contactListSize

contactsInDefaultWindow

Long contactsInDefaultWindow

contactsMappedToASingleZone

Long contactsMappedToASingleZone

contactsMappedToASingleZoneUsingZipCode

Long contactsMappedToASingleZoneUsingZipCode

contactsMappedToMultipleZones

Long contactsMappedToMultipleZones

contactsMappedToMultipleZonesUsingZipCode

Long contactsMappedToMultipleZonesUsingZipCode

contactsMappedUsingZipCode

Map<String,Long> contactsMappedUsingZipCode

contactsPerTimeZone

Map<String,Long> contactsPerTimeZone

Class com.mypurecloud.sdk.v2.model.TokenInfo

class TokenInfo extends Object implements Serializable

Serialized Fields

authorizedScope

List<String> authorizedScope

clonedUser

TokenInfoClonedUser clonedUser

homeOrganization

NamedEntity homeOrganization

oAuthClient

OrgOAuthClient oAuthClient

organization

NamedEntity organization

Class com.mypurecloud.sdk.v2.model.TokenInfoClonedUser

class TokenInfoClonedUser extends Object implements Serializable

Serialized Fields

id

String id

organization

Entity organization

Class com.mypurecloud.sdk.v2.model.Topic

class Topic extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

datePublished

Date datePublished

description

String description

dialect

String dialect

id

String id

modifiedBy

AddressableEntityRef modifiedBy

name

String name

participants

Topic.ParticipantsEnum participants

phrases

List<Phrase> phrases

programs

List<BaseProgramEntity> programs

published

Boolean published

publishedBy

AddressableEntityRef publishedBy

selfUri

String selfUri

strictness

Topic.StrictnessEnum strictness

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.TopicCursorEntityListing

class TopicCursorEntityListing extends Object implements Serializable

Serialized Fields

entities

List<String> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.TopicDuration

class TopicDuration extends Object implements Serializable

Serialized Fields

totalMilliseconds

Long totalMilliseconds

Class com.mypurecloud.sdk.v2.model.TopicJob

class TopicJob extends Object implements Serializable

Serialized Fields

createdBy

AddressableEntityRef createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

selfUri

String selfUri

state

TopicJob.StateEnum state

topics

List<BaseTopicEntitiy> topics

Class com.mypurecloud.sdk.v2.model.TopicJobRequest

class TopicJobRequest extends Object implements Serializable

Serialized Fields

topicIds

List<String> topicIds

Class com.mypurecloud.sdk.v2.model.TopicOffset

class TopicOffset extends Object implements Serializable

Serialized Fields

characterCount

Long characterCount

wordCount

Long wordCount

Class com.mypurecloud.sdk.v2.model.TopicPhrase

class TopicPhrase extends Object implements Serializable

Serialized Fields

id

String id

text

String text

utteranceCount

Integer utteranceCount

Class com.mypurecloud.sdk.v2.model.TopicRequest

class TopicRequest extends Object implements Serializable

Serialized Fields

description

String description

dialect

String dialect

name

String name

participants

TopicRequest.ParticipantsEnum participants

phrases

List<Phrase> phrases

programIds

List<String> programIds

strictness

TopicRequest.StrictnessEnum strictness

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.TopicsEntityListing

class TopicsEntityListing extends Object implements Serializable

Serialized Fields

entities

List<ListedTopic> entities

nextUri

String nextUri

pageCount

Integer pageCount

pageSize

Integer pageSize

selfUri

String selfUri

total

Integer total

Class com.mypurecloud.sdk.v2.model.Touchpoint

class Touchpoint extends Object implements Serializable

Serialized Fields

agentId

String agentId

associatedValue

BigDecimal associatedValue

conversationId

String conversationId

createdDate

Date createdDate

mediaType

Touchpoint.MediaTypeEnum mediaType

Class com.mypurecloud.sdk.v2.model.TouchpointResponse

class TouchpointResponse extends Object implements Serializable

Serialized Fields

agentId

String agentId

associatedValue

BigDecimal associatedValue

conversationId

String conversationId

createdDate

Date createdDate

mediaType

TouchpointResponse.MediaTypeEnum mediaType

message

String message

state

TouchpointResponse.StateEnum state

Class com.mypurecloud.sdk.v2.model.TrainingListing

class TrainingListing extends Object implements Serializable

Serialized Fields

entities

List<KnowledgeTraining> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.TranscriptAggregateDataContainer

class TranscriptAggregateDataContainer extends Object implements Serializable

Serialized Fields

data

List<StatisticalResponse> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.TranscriptAggregateQueryClause

class TranscriptAggregateQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<TranscriptAggregateQueryPredicate> predicates

type

TranscriptAggregateQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.TranscriptAggregateQueryFilter

class TranscriptAggregateQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<TranscriptAggregateQueryClause> clauses

predicates

List<TranscriptAggregateQueryPredicate> predicates

type

TranscriptAggregateQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.TranscriptAggregateQueryPredicate

class TranscriptAggregateQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

TranscriptAggregateQueryPredicate.DimensionEnum dimension

operator

TranscriptAggregateQueryPredicate.OperatorEnum operator

range

NumericRange range

type

TranscriptAggregateQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.TranscriptAggregateQueryResponse

class TranscriptAggregateQueryResponse extends Object implements Serializable

Serialized Fields

results

List<TranscriptAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.TranscriptAggregationQuery

class TranscriptAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

TranscriptAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

TranscriptAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<TranscriptAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<TranscriptAggregationQuery.MetricsEnum> metrics

timeZone

String timeZone

views

List<TranscriptAggregationView> views

Class com.mypurecloud.sdk.v2.model.TranscriptAggregationView

class TranscriptAggregationView extends Object implements Serializable

Serialized Fields

function

TranscriptAggregationView.FunctionEnum function

name

String name

range

AggregationRange range

target

TranscriptAggregationView.TargetEnum target

Class com.mypurecloud.sdk.v2.model.TranscriptAsyncAggregateQueryResponse

class TranscriptAsyncAggregateQueryResponse extends Object implements Serializable

Serialized Fields

cursor

String cursor

results

List<TranscriptAggregateDataContainer> results

Class com.mypurecloud.sdk.v2.model.TranscriptAsyncAggregationQuery

class TranscriptAsyncAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

TranscriptAsyncAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

TranscriptAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<TranscriptAsyncAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<TranscriptAsyncAggregationQuery.MetricsEnum> metrics

pageSize

Integer pageSize

timeZone

String timeZone

views

List<TranscriptAggregationView> views

Class com.mypurecloud.sdk.v2.model.TranscriptConversationDetailSearchCriteria

class TranscriptConversationDetailSearchCriteria extends Object implements Serializable

Serialized Fields

dateFormat

String dateFormat

endValue

String endValue

fields

List<String> fields

group

List<TranscriptConversationDetailSearchCriteria> group

operator

TranscriptConversationDetailSearchCriteria.OperatorEnum operator

startValue

String startValue

type

TranscriptConversationDetailSearchCriteria.TypeEnum type

value

String value

values

List<String> values

Class com.mypurecloud.sdk.v2.model.TranscriptConversationDetailSearchRequest

class TranscriptConversationDetailSearchRequest extends Object implements Serializable

Serialized Fields

pageNumber

Integer pageNumber

pageSize

Integer pageSize

query

List<TranscriptConversationDetailSearchCriteria> query

sort

List<SearchSort> sort

sortBy

String sortBy

sortOrder

TranscriptConversationDetailSearchRequest.SortOrderEnum sortOrder

types

List<String> types

Class com.mypurecloud.sdk.v2.model.TranscriptionEngines

class TranscriptionEngines extends Object implements Serializable

Serialized Fields

dialects

List<String> dialects

engine

TranscriptionEngines.EngineEnum engine

Class com.mypurecloud.sdk.v2.model.TranscriptionEnginesRequest

class TranscriptionEnginesRequest extends Object implements Serializable

Serialized Fields

transcriptionEngines

List<TranscriptionEngines> transcriptionEngines

Class com.mypurecloud.sdk.v2.model.TranscriptionSettings

class TranscriptionSettings extends Object implements Serializable

Serialized Fields

contentSearchEnabled

Boolean contentSearchEnabled

lowLatencyTranscriptionEnabled

Boolean lowLatencyTranscriptionEnabled

transcription

TranscriptionSettings.TranscriptionEnum transcription

transcriptionConfidenceThreshold

Integer transcriptionConfidenceThreshold

Class com.mypurecloud.sdk.v2.model.TranscriptionTopicTranscriptAlternative

class TranscriptionTopicTranscriptAlternative extends Object implements Serializable

Serialized Fields

confidence

BigDecimal confidence

durationMs

Integer durationMs

offsetMs

Integer offsetMs

transcript

String transcript

words

List<TranscriptionTopicTranscriptWord> words

Class com.mypurecloud.sdk.v2.model.TranscriptionTopicTranscriptionMessage

class TranscriptionTopicTranscriptionMessage extends Object implements Serializable

Serialized Fields

communicationId

String communicationId

conversationId

String conversationId

eventTime

Date eventTime

organizationId

String organizationId

sessionStartTimeMs

Integer sessionStartTimeMs

status

TranscriptionTopicTranscriptionRequestStatus status

transcriptionStartTimeMs

Integer transcriptionStartTimeMs

transcripts

List<TranscriptionTopicTranscriptResult> transcripts

Class com.mypurecloud.sdk.v2.model.TranscriptionTopicTranscriptionRequestStatus

class TranscriptionTopicTranscriptionRequestStatus extends Object implements Serializable

Serialized Fields

offsetMs

Integer offsetMs

status

TranscriptionTopicTranscriptionRequestStatus.StatusEnum status

Class com.mypurecloud.sdk.v2.model.TranscriptionTopicTranscriptResult

class TranscriptionTopicTranscriptResult extends Object implements Serializable

Serialized Fields

agentAssistantId

String agentAssistantId

agentAssistEnabled

Boolean agentAssistEnabled

alternatives

List<TranscriptionTopicTranscriptAlternative> alternatives

channel

TranscriptionTopicTranscriptResult.ChannelEnum channel

dialect

String dialect

engineId

String engineId

isFinal

Boolean isFinal

speechTextAnalyticsProgramId

String speechTextAnalyticsProgramId

utteranceId

String utteranceId

voiceTranscriptionEnabled

Boolean voiceTranscriptionEnabled

Class com.mypurecloud.sdk.v2.model.TranscriptionTopicTranscriptWord

class TranscriptionTopicTranscriptWord extends Object implements Serializable

Serialized Fields

confidence

BigDecimal confidence

durationMs

Integer durationMs

offsetMs

Integer offsetMs

startTimeMs

Integer startTimeMs

word

String word

Class com.mypurecloud.sdk.v2.model.Transcripts

class Transcripts extends Object implements Serializable

Serialized Fields

contains

List<String> contains

doesNotContain

List<String> doesNotContain

exactMatch

List<String> exactMatch

Class com.mypurecloud.sdk.v2.model.TranscriptSearchCriteria

class TranscriptSearchCriteria extends Object implements Serializable

Serialized Fields

dateFormat

String dateFormat

endValue

String endValue

fields

List<String> fields

group

List<TranscriptSearchCriteria> group

operator

TranscriptSearchCriteria.OperatorEnum operator

startValue

String startValue

type

TranscriptSearchCriteria.TypeEnum type

value

String value

values

List<String> values

Class com.mypurecloud.sdk.v2.model.TranscriptSearchRequest

class TranscriptSearchRequest extends Object implements Serializable

Serialized Fields

pageNumber

Integer pageNumber

pageSize

Integer pageSize

query

List<TranscriptSearchCriteria> query

returnFields

List<String> returnFields

sort

List<SearchSort> sort

sortBy

String sortBy

sortOrder

TranscriptSearchRequest.SortOrderEnum sortOrder

types

List<String> types

Class com.mypurecloud.sdk.v2.model.TranscriptTopic

class TranscriptTopic extends Object implements Serializable

Serialized Fields

confidence

Integer confidence

duration

TopicDuration duration

id

String id

name

String name

offset

TopicOffset offset

recordingLocation

Long recordingLocation

startTimeMilliseconds

Long startTimeMilliseconds

topicPhrase

String topicPhrase

transcriptPhrase

String transcriptPhrase

Class com.mypurecloud.sdk.v2.model.TranscriptTopics

class TranscriptTopics extends Object implements Serializable

Serialized Fields

excludes

List<String> excludes

includes

List<String> includes

Class com.mypurecloud.sdk.v2.model.TranscriptUrl

class TranscriptUrl extends Object implements Serializable

Serialized Fields

url

String url

Class com.mypurecloud.sdk.v2.model.TransferDestination

class TransferDestination extends Object implements Serializable

Serialized Fields

address

String address

userId

String userId

Class com.mypurecloud.sdk.v2.model.TransferInitiator

class TransferInitiator extends Object implements Serializable

Serialized Fields

userId

String userId

Class com.mypurecloud.sdk.v2.model.TransferRequest

class TransferRequest extends Object implements Serializable

Serialized Fields

address

String address

queueId

String queueId

transferType

TransferRequest.TransferTypeEnum transferType

userId

String userId

userName

String userName

voicemail

Boolean voicemail

Class com.mypurecloud.sdk.v2.model.TransferResponse

class TransferResponse extends Object implements Serializable

Serialized Fields

dateIssued

Date dateIssued

destination

TransferDestination destination

id

String id

initiator

TransferInitiator initiator

modifiedBy

TransferResponseModifiedBy modifiedBy

state

TransferResponse.StateEnum state

transferType

TransferResponse.TransferTypeEnum transferType

Class com.mypurecloud.sdk.v2.model.TransferResponseModifiedBy

class TransferResponseModifiedBy extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.TrendData

class TrendData extends Object implements Serializable

Serialized Fields

dateEndWorkday

LocalDate dateEndWorkday

dateStartWorkday

LocalDate dateStartWorkday

percentOfGoal

Double percentOfGoal

Class com.mypurecloud.sdk.v2.model.Trigger

class Trigger extends Object implements Serializable

Serialized Fields

delayBySeconds

Integer delayBySeconds

description

String description

enabled

Boolean enabled

eventTTLSeconds

Integer eventTTLSeconds

id

String id

matchCriteria

List<MatchCriteria> matchCriteria

name

String name

selfUri

String selfUri

target

TriggerTarget target

topicName

String topicName

version

Long version

Class com.mypurecloud.sdk.v2.model.TriggerEntityListing

class TriggerEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Trigger> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.TriggerTarget

class TriggerTarget extends Object implements Serializable

Serialized Fields

id

String id

type

TriggerTarget.TypeEnum type

workflowTargetSettings

WorkflowTargetSettings workflowTargetSettings

Class com.mypurecloud.sdk.v2.model.Trunk

class Trunk extends Object implements Serializable

Serialized Fields

connectedStatus

TrunkConnectedStatus connectedStatus

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

edge

DomainEntityRef edge

edgeGroup

DomainEntityRef edgeGroup

enabled

Boolean enabled

family

Integer family

id

String id

inService

Boolean inService

ipStatus

TrunkMetricsNetworkTypeIp ipStatus

logicalInterface

DomainEntityRef logicalInterface

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

optionsEnabledStatus

Trunk.OptionsEnabledStatusEnum optionsEnabledStatus

optionsStatus

List<TrunkMetricsOptions> optionsStatus

proxyAddressList

List<String> proxyAddressList

registersEnabledStatus

Trunk.RegistersEnabledStatusEnum registersEnabledStatus

registersStatus

List<TrunkMetricsRegisters> registersStatus

selfUri

String selfUri

state

Trunk.StateEnum state

trunkBase

DomainEntityRef trunkBase

trunkMetabase

DomainEntityRef trunkMetabase

trunkType

Trunk.TrunkTypeEnum trunkType

version

Integer version

Class com.mypurecloud.sdk.v2.model.TrunkBase

class TrunkBase extends Object implements Serializable

Serialized Fields

createdBy

String createdBy

createdByApp

String createdByApp

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

id

String id

managed

Boolean managed

modifiedBy

String modifiedBy

modifiedByApp

String modifiedByApp

name

String name

properties

Map<String,Object> properties

selfUri

String selfUri

state

TrunkBase.StateEnum state

trunkMetabase

DomainEntityRef trunkMetabase

trunkType

TrunkBase.TrunkTypeEnum trunkType

version

Integer version

Class com.mypurecloud.sdk.v2.model.TrunkBaseAssignment

class TrunkBaseAssignment extends Object implements Serializable

Serialized Fields

family

Integer family

trunkBase

TrunkBase trunkBase

Class com.mypurecloud.sdk.v2.model.TrunkBaseEntityListing

class TrunkBaseEntityListing extends Object implements Serializable

Serialized Fields

entities

List<TrunkBase> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.TrunkConnectedStatus

class TrunkConnectedStatus extends Object implements Serializable

Serialized Fields

connected

Boolean connected

connectedStateTime

Date connectedStateTime

Class com.mypurecloud.sdk.v2.model.TrunkEntityListing

class TrunkEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Trunk> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.TrunkErrorInfo

class TrunkErrorInfo extends Object implements Serializable

Serialized Fields

code

String code

details

TrunkErrorInfoDetails details

text

String text

Class com.mypurecloud.sdk.v2.model.TrunkErrorInfoDetails

class TrunkErrorInfoDetails extends Object implements Serializable

Serialized Fields

code

String code

hostname

String hostname

message

String message

Class com.mypurecloud.sdk.v2.model.TrunkInstanceTopicTrunk

class TrunkInstanceTopicTrunk extends Object implements Serializable

Serialized Fields

connectedStatus

TrunkInstanceTopicTrunkConnectedStatus connectedStatus

id

String id

ipStatus

TrunkInstanceTopicTrunkMetricsNetworkTypeIp ipStatus

optionsStatus

List<TrunkInstanceTopicTrunkMetricsOptions> optionsStatus

registersStatus

List<TrunkInstanceTopicTrunkMetricsRegisters> registersStatus

Class com.mypurecloud.sdk.v2.model.TrunkInstanceTopicTrunkConnectedStatus

class TrunkInstanceTopicTrunkConnectedStatus extends Object implements Serializable

Serialized Fields

connected

Boolean connected

connectedStateTime

Date connectedStateTime

Class com.mypurecloud.sdk.v2.model.TrunkInstanceTopicTrunkErrorInfo

class TrunkInstanceTopicTrunkErrorInfo extends Object implements Serializable

Serialized Fields

code

String code

details

TrunkInstanceTopicTrunkErrorInfoDetails details

text

String text

Class com.mypurecloud.sdk.v2.model.TrunkInstanceTopicTrunkErrorInfoDetails

class TrunkInstanceTopicTrunkErrorInfoDetails extends Object implements Serializable

Serialized Fields

code

String code

hostname

String hostname

message

String message

Class com.mypurecloud.sdk.v2.model.TrunkInstanceTopicTrunkMetricsNetworkTypeIp

class TrunkInstanceTopicTrunkMetricsNetworkTypeIp extends Object implements Serializable

Serialized Fields

address

String address

errorInfo

TrunkInstanceTopicTrunkErrorInfo errorInfo

Class com.mypurecloud.sdk.v2.model.TrunkInstanceTopicTrunkMetricsOptions

class TrunkInstanceTopicTrunkMetricsOptions extends Object implements Serializable

Serialized Fields

errorInfo

TrunkInstanceTopicTrunkErrorInfo errorInfo

optionState

Boolean optionState

optionStateTime

Date optionStateTime

proxyAddress

String proxyAddress

Class com.mypurecloud.sdk.v2.model.TrunkInstanceTopicTrunkMetricsRegisters

class TrunkInstanceTopicTrunkMetricsRegisters extends Object implements Serializable

Serialized Fields

errorInfo

TrunkInstanceTopicTrunkErrorInfo errorInfo

proxyAddress

String proxyAddress

registerState

Boolean registerState

registerStateTime

Date registerStateTime

Class com.mypurecloud.sdk.v2.model.TrunkMetabaseEntityListing

class TrunkMetabaseEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Metabase> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.TrunkMetrics

class TrunkMetrics extends Object implements Serializable

Serialized Fields

calls

TrunkMetricsCalls calls

eventTime

Date eventTime

logicalInterface

DomainEntityRef logicalInterface

qos

TrunkMetricsQoS qos

trunk

DomainEntityRef trunk

Class com.mypurecloud.sdk.v2.model.TrunkMetricsCalls

class TrunkMetricsCalls extends Object implements Serializable

Serialized Fields

inboundCallCount

Integer inboundCallCount

outboundCallCount

Integer outboundCallCount

Class com.mypurecloud.sdk.v2.model.TrunkMetricsNetworkTypeIp

class TrunkMetricsNetworkTypeIp extends Object implements Serializable

Serialized Fields

address

String address

errorInfo

TrunkErrorInfo errorInfo

Class com.mypurecloud.sdk.v2.model.TrunkMetricsOptions

class TrunkMetricsOptions extends Object implements Serializable

Serialized Fields

errorInfo

TrunkErrorInfo errorInfo

optionState

Boolean optionState

optionStateTime

Date optionStateTime

proxyAddress

String proxyAddress

Class com.mypurecloud.sdk.v2.model.TrunkMetricsQoS

class TrunkMetricsQoS extends Object implements Serializable

Serialized Fields

mismatchCount

Integer mismatchCount

Class com.mypurecloud.sdk.v2.model.TrunkMetricsRegisters

class TrunkMetricsRegisters extends Object implements Serializable

Serialized Fields

errorInfo

TrunkErrorInfo errorInfo

proxyAddress

String proxyAddress

registerState

Boolean registerState

registerStateTime

Date registerStateTime

Class com.mypurecloud.sdk.v2.model.TrunkMetricsTopicTrunkMetrics

class TrunkMetricsTopicTrunkMetrics extends Object implements Serializable

Serialized Fields

calls

TrunkMetricsTopicTrunkMetricsCalls calls

eventTime

Date eventTime

qos

TrunkMetricsTopicTrunkMetricsQoS qos

trunk

TrunkMetricsTopicUriReference trunk

Class com.mypurecloud.sdk.v2.model.TrunkMetricsTopicTrunkMetricsCalls

class TrunkMetricsTopicTrunkMetricsCalls extends Object implements Serializable

Serialized Fields

inboundCallCount

Integer inboundCallCount

outboundCallCount

Integer outboundCallCount

Class com.mypurecloud.sdk.v2.model.TrunkMetricsTopicTrunkMetricsQoS

class TrunkMetricsTopicTrunkMetricsQoS extends Object implements Serializable

Serialized Fields

mismatchCount

Integer mismatchCount

Class com.mypurecloud.sdk.v2.model.TrunkMetricsTopicUriReference

class TrunkMetricsTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.TrunkRecordingEnabledCount

class TrunkRecordingEnabledCount extends Object implements Serializable

Serialized Fields

disabledCount

Integer disabledCount

enabledCount

Integer enabledCount

Class com.mypurecloud.sdk.v2.model.TrustCreate

class TrustCreate extends Object implements Serializable

Serialized Fields

dateExpired

Date dateExpired

enabled

Boolean enabled

groups

List<TrustMemberCreate> groups

pairingId

String pairingId

users

List<TrustMemberCreate> users

Class com.mypurecloud.sdk.v2.model.Trustee

class Trustee extends Object implements Serializable

Serialized Fields

createdBy

OrgUser createdBy

dateCreated

Date dateCreated

dateExpired

Date dateExpired

enabled

Boolean enabled

id

String id

organization

Organization organization

selfUri

String selfUri

usesDefaultRole

Boolean usesDefaultRole

Class com.mypurecloud.sdk.v2.model.TrusteeAuditQueryRequest

class TrusteeAuditQueryRequest extends Object implements Serializable

Serialized Fields

endDate

Date endDate

facets

List<Facet> facets

filters

List<Filter> filters

queryPhrase

String queryPhrase

startDate

Date startDate

trusteeOrganizationIds

List<String> trusteeOrganizationIds

trusteeUserIds

List<String> trusteeUserIds

Class com.mypurecloud.sdk.v2.model.TrusteeAuthorization

class TrusteeAuthorization extends Object implements Serializable

Serialized Fields

permissions

List<String> permissions

Class com.mypurecloud.sdk.v2.model.TrusteeBillingOverview

class TrusteeBillingOverview extends Object implements Serializable

Serialized Fields

billingPeriodEndDate

Date billingPeriodEndDate

billingPeriodStartDate

Date billingPeriodStartDate

contractAmendmentDate

Date contractAmendmentDate

contractEffectiveDate

Date contractEffectiveDate

contractEndDate

Date contractEndDate

currency

String currency

enabledProducts

List<String> enabledProducts

id

String id

inRampPeriod

Boolean inRampPeriod

minimumMonthlyAmount

String minimumMonthlyAmount

name

String name

organization

NamedEntity organization

rampPeriodEndDate

Date rampPeriodEndDate

rampPeriodStartDate

Date rampPeriodStartDate

selfUri

String selfUri

subscriptionType

TrusteeBillingOverview.SubscriptionTypeEnum subscriptionType

usages

List<SubscriptionOverviewUsage> usages

Class com.mypurecloud.sdk.v2.model.TrustEntityListing

class TrustEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Trustee> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.TrustGroup

class TrustGroup extends Object implements Serializable

Serialized Fields

addresses

List<GroupContact> addresses

createdBy

OrgUser createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

id

String id

images

List<UserImage> images

memberCount

Long memberCount

name

String name

owners

List<User> owners

rulesVisible

Boolean rulesVisible

state

TrustGroup.StateEnum state

type

TrustGroup.TypeEnum type

version

Integer version

visibility

TrustGroup.VisibilityEnum visibility

Class com.mypurecloud.sdk.v2.model.TrustGroupEntityListing

class TrustGroupEntityListing extends Object implements Serializable

Serialized Fields

entities

List<TrustGroup> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.TrustMemberCreate

class TrustMemberCreate extends Object implements Serializable

Serialized Fields

id

String id

roleDivisions

RoleDivisionGrants roleDivisions

roleIds

List<String> roleIds

Class com.mypurecloud.sdk.v2.model.Trustor

class Trustor extends Object implements Serializable

Serialized Fields

authorization

TrusteeAuthorization authorization

createdBy

OrgUser createdBy

dateCreated

Date dateCreated

enabled

Boolean enabled

id

String id

organization

Organization organization

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.TrustorAuditQueryRequest

class TrustorAuditQueryRequest extends Object implements Serializable

Serialized Fields

endDate

Date endDate

facets

List<Facet> facets

filters

List<Filter> filters

queryPhrase

String queryPhrase

startDate

Date startDate

trusteeUserIds

List<String> trusteeUserIds

trustorOrganizationId

String trustorOrganizationId

Class com.mypurecloud.sdk.v2.model.TrustorEntityListing

class TrustorEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Trustor> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.TrustRequest

class TrustRequest extends Object implements Serializable

Serialized Fields

createdBy

OrgUser createdBy

dateCreated

Date dateCreated

groups

List<TrustGroup> groups

id

String id

selfUri

String selfUri

trustee

Organization trustee

users

List<OrgUser> users

Class com.mypurecloud.sdk.v2.model.TrustRequestCreate

class TrustRequestCreate extends Object implements Serializable

Serialized Fields

groupIds

List<String> groupIds

userIds

List<String> userIds

Class com.mypurecloud.sdk.v2.model.TrustUpdate

class TrustUpdate extends Object implements Serializable

Serialized Fields

dateExpired

Date dateExpired

enabled

Boolean enabled

Class com.mypurecloud.sdk.v2.model.TrustUser

class TrustUser extends Object implements Serializable

Serialized Fields

acdAutoAnswer

Boolean acdAutoAnswer

addresses

List<Contact> addresses

authorization

UserAuthorization authorization

biography

Biography biography

certifications

List<String> certifications

chat

Chat chat

conversationSummary

UserConversationSummary conversationSummary

dateLastLogin

Date dateLastLogin

department

String department

division

Division division

email

String email

employerInfo

EmployerInfo employerInfo

geolocation

Geolocation geolocation

groups

List<Group> groups

id

String id

images

List<UserImage> images

integrationPresence

UserPresence integrationPresence

languagePreference

String languagePreference

languages

List<UserRoutingLanguage> languages

lastTokenIssued

OAuthLastTokenIssued lastTokenIssued

locations

List<Location> locations

manager

User manager

name

String name

outOfOffice

OutOfOffice outOfOffice

presence

UserPresence presence

primaryContactInfo

List<Contact> primaryContactInfo

profileSkills

List<String> profileSkills

routingStatus

RoutingStatus routingStatus

skills

List<UserRoutingSkill> skills

state

TrustUser.StateEnum state

station

UserStations station

team

Team team

title

String title

trustUserDetails

TrustUserDetails trustUserDetails

username

String username

version

Integer version

Class com.mypurecloud.sdk.v2.model.TrustUserDetails

class TrustUserDetails extends Object implements Serializable

Serialized Fields

createdBy

OrgUser createdBy

dateCreated

Date dateCreated

Class com.mypurecloud.sdk.v2.model.TrustUserEntityListing

class TrustUserEntityListing extends Object implements Serializable

Serialized Fields

entities

List<TrustUser> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.TtsEngineEntity

class TtsEngineEntity extends Object implements Serializable

Serialized Fields

id

String id

isDefault

Boolean isDefault

isSecure

Boolean isSecure

languages

List<String> languages

name

String name

outputFormats

List<String> outputFormats

selfUri

String selfUri

voices

List<TtsVoiceEntity> voices

Class com.mypurecloud.sdk.v2.model.TtsEngineEntityListing

class TtsEngineEntityListing extends Object implements Serializable

Serialized Fields

entities

List<TtsEngineEntity> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.TtsSettings

class TtsSettings extends Object implements Serializable

Serialized Fields

defaultEngine

String defaultEngine

languageOverrides

List<LanguageOverride> languageOverrides

Class com.mypurecloud.sdk.v2.model.TtsVoiceEntity

class TtsVoiceEntity extends Object implements Serializable

Serialized Fields

engine

TtsEngineEntity engine

gender

String gender

id

String id

isDefault

Boolean isDefault

language

String language

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.TtsVoiceEntityListing

class TtsVoiceEntityListing extends Object implements Serializable

Serialized Fields

entities

List<TtsVoiceEntity> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.TwitterId

class TwitterId extends Object implements Serializable

Serialized Fields

id

String id

name

String name

profileUrl

String profileUrl

screenName

String screenName

verified

Boolean verified

Class com.mypurecloud.sdk.v2.model.TwitterIntegration

class TwitterIntegration extends Object implements Serializable

Serialized Fields

accessTokenKey

String accessTokenKey

consumerKey

String consumerKey

createdBy

DomainEntityRef createdBy

createError

ErrorBody createError

createStatus

TwitterIntegration.CreateStatusEnum createStatus

dateCreated

Date dateCreated

dateModified

Date dateModified

envName

String envName

id

String id

messagingSetting

MessagingSettingReference messagingSetting

modifiedBy

DomainEntityRef modifiedBy

name

String name

recipient

DomainEntityRef recipient

selfUri

String selfUri

status

String status

supportedContent

SupportedContentReference supportedContent

tier

TwitterIntegration.TierEnum tier

userId

String userId

username

String username

version

Integer version

Class com.mypurecloud.sdk.v2.model.TwitterIntegrationEntityListing

class TwitterIntegrationEntityListing extends Object implements Serializable

Serialized Fields

entities

List<TwitterIntegration> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.TwitterIntegrationRequest

class TwitterIntegrationRequest extends Object implements Serializable

Serialized Fields

accessTokenKey

String accessTokenKey

accessTokenSecret

String accessTokenSecret

consumerKey

String consumerKey

consumerSecret

String consumerSecret

envName

String envName

id

String id

messagingSetting

MessagingSettingRequestReference messagingSetting

name

String name

selfUri

String selfUri

supportedContent

SupportedContentReference supportedContent

tier

TwitterIntegrationRequest.TierEnum tier

Class com.mypurecloud.sdk.v2.model.TypingSetting

class TypingSetting extends Object implements Serializable

Serialized Fields

on

SettingDirection on

Class com.mypurecloud.sdk.v2.model.UCI10n

class UCI10n extends Object implements Serializable

Serialized Fields

name

String name

Class com.mypurecloud.sdk.v2.model.UCIcon

class UCIcon extends Object implements Serializable

Serialized Fields

vector

String vector

Class com.mypurecloud.sdk.v2.model.UCIntegration

class UCIntegration extends Object implements Serializable

Serialized Fields

badgeIcons

Map<String,UCIcon> badgeIcons

i10n

Map<String,UCI10n> i10n

icon

UCIcon icon

id

String id

integrationPresenceSource

UCIntegration.IntegrationPresenceSourceEnum integrationPresenceSource

name

String name

pbxPermission

String pbxPermission

polledPresence

Boolean polledPresence

selfUri

String selfUri

ucIntegrationKey

String ucIntegrationKey

userPermissions

List<String> userPermissions

Class com.mypurecloud.sdk.v2.model.UCIntegrationListing

class UCIntegrationListing extends Object implements Serializable

Serialized Fields

entities

List<UCIntegration> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.UnansweredGroup

class UnansweredGroup extends Object implements Serializable

Serialized Fields

id

String id

label

String label

phraseGroups

List<UnansweredPhraseGroup> phraseGroups

selfUri

String selfUri

statistics

KnowledgeGroupStatistics statistics

suggestedDocuments

List<UnansweredGroupSuggestedDocument> suggestedDocuments

Class com.mypurecloud.sdk.v2.model.UnansweredGroups

class UnansweredGroups extends Object implements Serializable

Serialized Fields

entities

List<UnansweredGroup> entities

Class com.mypurecloud.sdk.v2.model.UnansweredGroupSuggestedDocument

class UnansweredGroupSuggestedDocument extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.UnansweredPhrase

class UnansweredPhrase extends Object implements Serializable

Serialized Fields

id

String id

text

String text

unlinkedPhraseHitCount

Integer unlinkedPhraseHitCount

Class com.mypurecloud.sdk.v2.model.UnansweredPhraseGroup

class UnansweredPhraseGroup extends Object implements Serializable

Serialized Fields

id

String id

label

String label

phrases

List<UnansweredPhrase> phrases

selfUri

String selfUri

unlinkedPhraseCount

Integer unlinkedPhraseCount

unlinkedPhraseHitCount

Integer unlinkedPhraseHitCount

Class com.mypurecloud.sdk.v2.model.UnansweredPhraseGroupPatchRequestBody

class UnansweredPhraseGroupPatchRequestBody extends Object implements Serializable

Serialized Fields

phraseAssociations

List<PhraseAssociations> phraseAssociations

Class com.mypurecloud.sdk.v2.model.UnansweredPhraseGroupUpdateResponse

class UnansweredPhraseGroupUpdateResponse extends Object implements Serializable

Serialized Fields

group

UnansweredGroup group

phraseAssociations

List<PhraseAssociations> phraseAssociations

Class com.mypurecloud.sdk.v2.model.UnifiedGeneralTopic

class UnifiedGeneralTopic extends Object implements Serializable

Serialized Fields

name

String name

status

UnifiedGeneralTopic.StatusEnum status

Class com.mypurecloud.sdk.v2.model.UnifiedGeneralTopicEntityListing

class UnifiedGeneralTopicEntityListing extends Object implements Serializable

Serialized Fields

entities

List<UnifiedGeneralTopic> entities

Class com.mypurecloud.sdk.v2.model.UnpublishedProgramsEntityListing

class UnpublishedProgramsEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Program> entities

nextUri

String nextUri

pageCount

Integer pageCount

pageSize

Integer pageSize

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.UnreadMetric

class UnreadMetric extends Object implements Serializable

Serialized Fields

count

Integer count

Class com.mypurecloud.sdk.v2.model.UnreadStatus

class UnreadStatus extends Object implements Serializable

Serialized Fields

unread

Boolean unread

Class com.mypurecloud.sdk.v2.model.UpdateActionInput

class UpdateActionInput extends Object implements Serializable

Serialized Fields

category

String category

config

ActionConfig config

name

String name

version

Integer version

Class com.mypurecloud.sdk.v2.model.UpdateActivityCodeRequest

class UpdateActivityCodeRequest extends Object implements Serializable

Serialized Fields

agentTimeOffSelectable

Boolean agentTimeOffSelectable

category

UpdateActivityCodeRequest.CategoryEnum category

countsAsPaidTime

Boolean countsAsPaidTime

countsAsWorkTime

Boolean countsAsWorkTime

countsTowardShrinkage

Boolean countsTowardShrinkage

interruptible

Boolean interruptible

lengthInMinutes

Integer lengthInMinutes

metadata

WfmVersionedEntityMetadata metadata

name

String name

plannedShrinkage

Boolean plannedShrinkage

secondaryPresences

ListWrapperSecondaryPresence secondaryPresences

Class com.mypurecloud.sdk.v2.model.UpdateAdherenceExplanationStatusRequest

class UpdateAdherenceExplanationStatusRequest extends Object implements Serializable

Serialized Fields

status

UpdateAdherenceExplanationStatusRequest.StatusEnum status

Class com.mypurecloud.sdk.v2.model.UpdateAnalyticsDataRetentionRequest

class UpdateAnalyticsDataRetentionRequest extends Object implements Serializable

Serialized Fields

retentionDays

Integer retentionDays

Class com.mypurecloud.sdk.v2.model.UpdateBusinessUnitRequest

class UpdateBusinessUnitRequest extends Object implements Serializable

Serialized Fields

divisionId

String divisionId

name

String name

settings

UpdateBusinessUnitSettingsRequest settings

Class com.mypurecloud.sdk.v2.model.UpdateBusinessUnitSettingsRequest

class UpdateBusinessUnitSettingsRequest extends Object implements Serializable

Serialized Fields

metadata

WfmVersionedEntityMetadata metadata

scheduling

BuSchedulingSettingsRequest scheduling

shortTermForecasting

BuShortTermForecastingSettings shortTermForecasting

startDayOfWeek

UpdateBusinessUnitSettingsRequest.StartDayOfWeekEnum startDayOfWeek

timeZone

String timeZone

Class com.mypurecloud.sdk.v2.model.UpdateCoachingAppointmentRequest

class UpdateCoachingAppointmentRequest extends Object implements Serializable

Serialized Fields

conversationIds

List<String> conversationIds

dateStart

Date dateStart

description

String description

documentIds

List<String> documentIds

externalLinks

List<String> externalLinks

lengthInMinutes

Integer lengthInMinutes

name

String name

status

UpdateCoachingAppointmentRequest.StatusEnum status

wfmSchedule

WfmScheduleReference wfmSchedule

Class com.mypurecloud.sdk.v2.model.UpdateContactColumnActionSettings

class UpdateContactColumnActionSettings extends Object implements Serializable

Serialized Fields

properties

Map<String,String> properties

updateOption

UpdateContactColumnActionSettings.UpdateOptionEnum updateOption

Class com.mypurecloud.sdk.v2.model.UpdateDraftInput

class UpdateDraftInput extends Object implements Serializable

Serialized Fields

category

String category

config

ActionConfig config

contract

ActionContractInput contract

name

String name

secure

Boolean secure

version

Integer version

Class com.mypurecloud.sdk.v2.model.UpdateManagementUnitRequest

class UpdateManagementUnitRequest extends Object implements Serializable

Serialized Fields

divisionId

String divisionId

name

String name

settings

ManagementUnitSettingsRequest settings

Class com.mypurecloud.sdk.v2.model.UpdateNotificationResponse

class UpdateNotificationResponse extends Object implements Serializable

Serialized Fields

id

String id

mutableGroupId

String mutableGroupId

Class com.mypurecloud.sdk.v2.model.UpdateNotificationsRequest

class UpdateNotificationsRequest extends Object implements Serializable

Serialized Fields

entities

List<WfmUserNotification> entities

Class com.mypurecloud.sdk.v2.model.UpdateNotificationsResponse

class UpdateNotificationsResponse extends Object implements Serializable

Serialized Fields

entities

List<UpdateNotificationResponse> entities

Class com.mypurecloud.sdk.v2.model.UpdatePlanningGroupRequest

class UpdatePlanningGroupRequest extends Object implements Serializable

Serialized Fields

metadata

WfmVersionedEntityMetadata metadata

name

String name

routePaths

SetWrapperRoutePathRequest routePaths

serviceGoalTemplateId

String serviceGoalTemplateId

Class com.mypurecloud.sdk.v2.model.UpdateScheduleUploadResponse

class UpdateScheduleUploadResponse extends Object implements Serializable

Serialized Fields

headers

Map<String,String> headers

uploadBodySchema

UpdateScheduleUploadSchema uploadBodySchema

uploadKey

String uploadKey

url

String url

Class com.mypurecloud.sdk.v2.model.UpdateScheduleUploadSchema

class UpdateScheduleUploadSchema extends Object implements Serializable

Serialized Fields

agentSchedules

List<BuUpdateAgentScheduleUploadSchema> agentSchedules

description

String description

headcountForecast

BuHeadcountForecast headcountForecast

metadata

WfmVersionedEntityMetadata metadata

published

Boolean published

shortTermForecast

BuShortTermForecastReference shortTermForecast

Class com.mypurecloud.sdk.v2.model.UpdateServiceGoalTemplate

class UpdateServiceGoalTemplate extends Object implements Serializable

Serialized Fields

abandonRate

BuAbandonRate abandonRate

averageSpeedOfAnswer

BuAverageSpeedOfAnswer averageSpeedOfAnswer

metadata

WfmVersionedEntityMetadata metadata

name

String name

serviceLevel

BuServiceLevel serviceLevel

Class com.mypurecloud.sdk.v2.model.UpdateTimeOffLimitRequest

class UpdateTimeOffLimitRequest extends Object implements Serializable

Serialized Fields

defaultLimitMinutes

Integer defaultLimitMinutes

metadata

WfmVersionedEntityMetadata metadata

Class com.mypurecloud.sdk.v2.model.UpdateTimeOffPlanRequest

class UpdateTimeOffPlanRequest extends Object implements Serializable

Serialized Fields

active

Boolean active

activityCodeIds

SetWrapperString activityCodeIds

autoApprovalRule

UpdateTimeOffPlanRequest.AutoApprovalRuleEnum autoApprovalRule

daysBeforeStartToExpireFromWaitlist

Integer daysBeforeStartToExpireFromWaitlist

metadata

WfmVersionedEntityMetadata metadata

name

String name

timeOffLimitIds

SetWrapperString timeOffLimitIds

Class com.mypurecloud.sdk.v2.model.UpdateTriggerRequest

class UpdateTriggerRequest extends Object implements Serializable

Serialized Fields

delayBySeconds

Integer delayBySeconds

description

String description

enabled

Boolean enabled

eventTTLSeconds

Integer eventTTLSeconds

matchCriteria

List<MatchCriteria> matchCriteria

name

String name

target

TriggerTarget target

topicName

String topicName

version

Long version

Class com.mypurecloud.sdk.v2.model.UpdateUser

class UpdateUser extends Object implements Serializable

Serialized Fields

acdAutoAnswer

Boolean acdAutoAnswer

addresses

List<Contact> addresses

biography

Biography biography

certifications

List<String> certifications

chat

Chat chat

department

String department

email

String email

employerInfo

EmployerInfo employerInfo

groups

List<Group> groups

id

String id

images

List<UserImage> images

locations

List<Location> locations

manager

String manager

name

String name

primaryContactInfo

List<Contact> primaryContactInfo

profileSkills

List<String> profileSkills

selfUri

String selfUri

state

UpdateUser.StateEnum state

title

String title

username

String username

version

Integer version

Class com.mypurecloud.sdk.v2.model.UpdateWorkPlanRotationAgentRequest

class UpdateWorkPlanRotationAgentRequest extends Object implements Serializable

Serialized Fields

dateRange

DateRangeWithOptionalEnd dateRange

delete

Boolean delete

position

Integer position

userId

String userId

Class com.mypurecloud.sdk.v2.model.UpdateWorkPlanRotationRequest

class UpdateWorkPlanRotationRequest extends Object implements Serializable

Serialized Fields

agents

List<UpdateWorkPlanRotationAgentRequest> agents

dateRange

DateRangeWithOptionalEnd dateRange

enabled

Boolean enabled

metadata

WfmVersionedEntityMetadata metadata

name

String name

pattern

WorkPlanPatternRequest pattern

Class com.mypurecloud.sdk.v2.model.UploadUrlRequest

class UploadUrlRequest extends Object implements Serializable

Serialized Fields

contentMd5

String contentMd5

contentType

String contentType

fileName

String fileName

serverSideEncryption

UploadUrlRequest.ServerSideEncryptionEnum serverSideEncryption

signedUrlTimeoutSeconds

Integer signedUrlTimeoutSeconds

Class com.mypurecloud.sdk.v2.model.UploadUrlRequestBody

class UploadUrlRequestBody extends Object implements Serializable

Serialized Fields

contentLengthBytes

Long contentLengthBytes

Class com.mypurecloud.sdk.v2.model.UploadUrlResponse

class UploadUrlResponse extends Object implements Serializable

Serialized Fields

headers

Map<String,String> headers

uploadKey

String uploadKey

url

String url

Class com.mypurecloud.sdk.v2.model.UrlCondition

class UrlCondition extends Object implements Serializable

Serialized Fields

operator

UrlCondition.OperatorEnum operator

values

List<String> values

Class com.mypurecloud.sdk.v2.model.UrlResponse

class UrlResponse extends Object implements Serializable

Serialized Fields

url

String url

Class com.mypurecloud.sdk.v2.model.Usage

class Usage extends Object implements Serializable

Serialized Fields

types

List<UsageItem> types

Class com.mypurecloud.sdk.v2.model.UsageExecutionResult

class UsageExecutionResult extends Object implements Serializable

Serialized Fields

executionId

String executionId

resultsUri

String resultsUri

Class com.mypurecloud.sdk.v2.model.UsageItem

class UsageItem extends Object implements Serializable

Serialized Fields

totalDocumentByteCount

Long totalDocumentByteCount

totalDocumentCount

Long totalDocumentCount

type

UsageItem.TypeEnum type

Class com.mypurecloud.sdk.v2.model.User

class User extends Object implements Serializable

Serialized Fields

acdAutoAnswer

Boolean acdAutoAnswer

addresses

List<Contact> addresses

authorization

UserAuthorization authorization

biography

Biography biography

certifications

List<String> certifications

chat

Chat chat

conversationSummary

UserConversationSummary conversationSummary

dateLastLogin

Date dateLastLogin

department

String department

division

Division division

email

String email

employerInfo

EmployerInfo employerInfo

geolocation

Geolocation geolocation

groups

List<Group> groups

id

String id

images

List<UserImage> images

integrationPresence

UserPresence integrationPresence

languagePreference

String languagePreference

languages

List<UserRoutingLanguage> languages

lastTokenIssued

OAuthLastTokenIssued lastTokenIssued

locations

List<Location> locations

manager

User manager

name

String name

outOfOffice

OutOfOffice outOfOffice

presence

UserPresence presence

primaryContactInfo

List<Contact> primaryContactInfo

profileSkills

List<String> profileSkills

routingStatus

RoutingStatus routingStatus

selfUri

String selfUri

skills

List<UserRoutingSkill> skills

state

User.StateEnum state

station

UserStations station

team

Team team

title

String title

username

String username

version

Integer version

Class com.mypurecloud.sdk.v2.model.UserActivityData

class UserActivityData extends Object implements Serializable

Serialized Fields

data

List<UserActivityMetricValue> data

entities

List<UserActivityEntityData> entities

group

Map<String,String> group

truncated

Boolean truncated

Class com.mypurecloud.sdk.v2.model.UserActivityEntityData

class UserActivityEntityData extends Object implements Serializable

Serialized Fields

activityDate

Date activityDate

organizationPresenceId

String organizationPresenceId

presenceDate

Date presenceDate

queueId

String queueId

queueMembershipStatus

String queueMembershipStatus

routingStatus

String routingStatus

routingStatusDate

Date routingStatusDate

systemPresence

String systemPresence

teamId

String teamId

userId

String userId

Class com.mypurecloud.sdk.v2.model.UserActivityMetricValue

class UserActivityMetricValue extends Object implements Serializable

Serialized Fields

count

Integer count

metric

UserActivityMetricValue.MetricEnum metric

Class com.mypurecloud.sdk.v2.model.UserActivityQuery

class UserActivityQuery extends Object implements Serializable

Serialized Fields

filter

UserActivityQueryFilter filter

groupBy

List<UserActivityQuery.GroupByEnum> groupBy

metrics

List<UserActivityQueryMetric> metrics

order

UserActivityQuery.OrderEnum order

Class com.mypurecloud.sdk.v2.model.UserActivityQueryClause

class UserActivityQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<UserActivityQueryPredicate> predicates

type

UserActivityQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.UserActivityQueryFilter

class UserActivityQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<UserActivityQueryClause> clauses

predicates

List<UserActivityQueryPredicate> predicates

type

UserActivityQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.UserActivityQueryMetric

class UserActivityQueryMetric extends Object implements Serializable

Serialized Fields

details

Boolean details

metric

UserActivityQueryMetric.MetricEnum metric

Class com.mypurecloud.sdk.v2.model.UserActivityQueryPredicate

class UserActivityQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

UserActivityQueryPredicate.DimensionEnum dimension

operator

UserActivityQueryPredicate.OperatorEnum operator

type

UserActivityQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.UserActivityResponse

class UserActivityResponse extends Object implements Serializable

Serialized Fields

entityIdDimension

UserActivityResponse.EntityIdDimensionEnum entityIdDimension

results

List<UserActivityData> results

Class com.mypurecloud.sdk.v2.model.UserAgentInfo

class UserAgentInfo extends Object implements Serializable

Serialized Fields

firmwareVersion

String firmwareVersion

manufacturer

String manufacturer

model

String model

Class com.mypurecloud.sdk.v2.model.UserAggregateDataContainer

class UserAggregateDataContainer extends Object implements Serializable

Serialized Fields

data

List<StatisticalResponse> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.UserAggregateQueryClause

class UserAggregateQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<UserAggregateQueryPredicate> predicates

type

UserAggregateQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.UserAggregateQueryFilter

class UserAggregateQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<UserAggregateQueryClause> clauses

predicates

List<UserAggregateQueryPredicate> predicates

type

UserAggregateQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.UserAggregateQueryPredicate

class UserAggregateQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

UserAggregateQueryPredicate.DimensionEnum dimension

operator

UserAggregateQueryPredicate.OperatorEnum operator

range

NumericRange range

type

UserAggregateQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.UserAggregateQueryResponse

class UserAggregateQueryResponse extends Object implements Serializable

Serialized Fields

results

List<UserAggregateDataContainer> results

systemToOrganizationMappings

Map<String,List<String>> systemToOrganizationMappings

Class com.mypurecloud.sdk.v2.model.UserAggregationQuery

class UserAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

UserAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

UserAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<UserAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<UserAggregationQuery.MetricsEnum> metrics

timeZone

String timeZone

views

List<UserAggregationView> views

Class com.mypurecloud.sdk.v2.model.UserAggregationView

class UserAggregationView extends Object implements Serializable

Serialized Fields

function

UserAggregationView.FunctionEnum function

name

String name

range

AggregationRange range

target

UserAggregationView.TargetEnum target

Class com.mypurecloud.sdk.v2.model.UserApp

class UserApp extends Object implements Serializable

Serialized Fields

config

UserAppConfigurationInfo config

id

String id

integrationType

IntegrationType integrationType

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.UserAppConfigurationInfo

class UserAppConfigurationInfo extends Object implements Serializable

Serialized Fields

current

IntegrationConfiguration current

effective

EffectiveConfiguration effective

Class com.mypurecloud.sdk.v2.model.UserAppEntityListing

class UserAppEntityListing extends Object implements Serializable

Serialized Fields

entities

List<UserApp> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.UserAsyncAggregateQueryResponse

class UserAsyncAggregateQueryResponse extends Object implements Serializable

Serialized Fields

cursor

String cursor

results

List<UserAggregateDataContainer> results

systemToOrganizationMappings

Map<String,List<String>> systemToOrganizationMappings

Class com.mypurecloud.sdk.v2.model.UserAsyncAggregationQuery

class UserAsyncAggregationQuery extends Object implements Serializable

Serialized Fields

alternateTimeDimension

UserAsyncAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension

filter

UserAggregateQueryFilter filter

flattenMultivaluedDimensions

Boolean flattenMultivaluedDimensions

granularity

String granularity

groupBy

List<UserAsyncAggregationQuery.GroupByEnum> groupBy

interval

String interval

metrics

List<UserAsyncAggregationQuery.MetricsEnum> metrics

pageSize

Integer pageSize

timeZone

String timeZone

views

List<UserAggregationView> views

Class com.mypurecloud.sdk.v2.model.UserAuthorization

class UserAuthorization extends Object implements Serializable

Serialized Fields

permissionPolicies

List<ResourcePermissionPolicy> permissionPolicies

permissions

List<String> permissions

roles

List<DomainRole> roles

unusedRoles

List<DomainRole> unusedRoles

Class com.mypurecloud.sdk.v2.model.UserAvailableTimes

class UserAvailableTimes extends Object implements Serializable

Serialized Fields

availableTimes

List<AvailableTime> availableTimes

user

UserReference user

Class com.mypurecloud.sdk.v2.model.UserBestPoints

class UserBestPoints extends Object implements Serializable

Serialized Fields

bestPoints

List<UserBestPointsItem> bestPoints

user

UserReference user

Class com.mypurecloud.sdk.v2.model.UserBestPointsItem

class UserBestPointsItem extends Object implements Serializable

Serialized Fields

dateEndWorkday

LocalDate dateEndWorkday

dateStartWorkday

LocalDate dateStartWorkday

granularityType

UserBestPointsItem.GranularityTypeEnum granularityType

points

Integer points

rank

Integer rank

Class com.mypurecloud.sdk.v2.model.UserConversationsEventMediaSummary

class UserConversationsEventMediaSummary extends Object implements Serializable

Serialized Fields

contactCenter

UserConversationsEventMediaSummaryDetail contactCenter

enterprise

UserConversationsEventMediaSummaryDetail enterprise

Class com.mypurecloud.sdk.v2.model.UserConversationsEventMediaSummaryDetail

class UserConversationsEventMediaSummaryDetail extends Object implements Serializable

Serialized Fields

active

Integer active

acw

Integer acw

Class com.mypurecloud.sdk.v2.model.UserConversationsEventUserConversationSummary

class UserConversationsEventUserConversationSummary extends Object implements Serializable

Serialized Fields

call

UserConversationsEventMediaSummary call

callback

UserConversationsEventMediaSummary callback

chat

UserConversationsEventMediaSummary chat

email

UserConversationsEventMediaSummary email

message

UserConversationsEventMediaSummary message

socialExpression

UserConversationsEventMediaSummary socialExpression

userId

String userId

video

UserConversationsEventMediaSummary video

Class com.mypurecloud.sdk.v2.model.UserConversationSummary

class UserConversationSummary extends Object implements Serializable

Serialized Fields

call

MediaSummary call

callback

MediaSummary callback

chat

MediaSummary chat

email

MediaSummary email

message

MediaSummary message

socialExpression

MediaSummary socialExpression

userId

String userId

video

MediaSummary video

Class com.mypurecloud.sdk.v2.model.UserDetailQueryClause

class UserDetailQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<UserDetailQueryPredicate> predicates

type

UserDetailQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.UserDetailQueryFilter

class UserDetailQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<UserDetailQueryClause> clauses

predicates

List<UserDetailQueryPredicate> predicates

type

UserDetailQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.UserDetailQueryPredicate

class UserDetailQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

UserDetailQueryPredicate.DimensionEnum dimension

operator

UserDetailQueryPredicate.OperatorEnum operator

range

NumericRange range

type

UserDetailQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.UserDetailsDatalakeAvailabilityTopicDataAvailabilityChangeNotification

class UserDetailsDatalakeAvailabilityTopicDataAvailabilityChangeNotification extends Object implements Serializable

Serialized Fields

dataAvailabilityDate

Date dataAvailabilityDate

Class com.mypurecloud.sdk.v2.model.UserDetailsQuery

class UserDetailsQuery extends Object implements Serializable

Serialized Fields

interval

String interval

order

UserDetailsQuery.OrderEnum order

paging

PagingSpec paging

presenceAggregations

List<AnalyticsQueryAggregation> presenceAggregations

presenceFilters

List<PresenceDetailQueryFilter> presenceFilters

routingStatusAggregations

List<AnalyticsQueryAggregation> routingStatusAggregations

routingStatusFilters

List<RoutingStatusDetailQueryFilter> routingStatusFilters

userFilters

List<UserDetailQueryFilter> userFilters

Class com.mypurecloud.sdk.v2.model.UserDevice

class UserDevice extends Object implements Serializable

Serialized Fields

acceptNotifications

Boolean acceptNotifications

deviceToken

String deviceToken

id

String id

make

String make

model

String model

name

String name

notificationId

String notificationId

selfUri

String selfUri

sessionHash

String sessionHash

type

UserDevice.TypeEnum type

Class com.mypurecloud.sdk.v2.model.UserEndDetailEventTopicUserEndEvent

class UserEndDetailEventTopicUserEndEvent extends Object implements Serializable

Serialized Fields

addressFrom

String addressFrom

addressTo

String addressTo

alertingDurationMs

Integer alertingDurationMs

ani

String ani

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Integer callbackScheduledTime

callbackUserName

String callbackUserName

contactingDurationMs

Integer contactingDurationMs

conversationExternalContactIds

List<String> conversationExternalContactIds

conversationExternalOrganizationIds

List<String> conversationExternalOrganizationIds

conversationId

String conversationId

dialingDurationMs

Integer dialingDurationMs

direction

UserEndDetailEventTopicUserEndEvent.DirectionEnum direction

disconnectType

UserEndDetailEventTopicUserEndEvent.DisconnectTypeEnum disconnectType

divisionId

String divisionId

dnis

String dnis

eventTime

Integer eventTime

heldDurationMs

Integer heldDurationMs

interactingDurationMs

Integer interactingDurationMs

mediaType

UserEndDetailEventTopicUserEndEvent.MediaTypeEnum mediaType

messageType

UserEndDetailEventTopicUserEndEvent.MessageTypeEnum messageType

participantId

String participantId

provider

String provider

queueId

String queueId

sessionId

String sessionId

subject

String subject

userId

String userId

Class com.mypurecloud.sdk.v2.model.UserEntityListing

class UserEntityListing extends Object implements Serializable

Serialized Fields

entities

List<User> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.UserEstablishedEvent

class UserEstablishedEvent extends Object implements Serializable

Serialized Fields

afterCallWorkRequired

Boolean afterCallWorkRequired

ani

String ani

communicationId

String communicationId

conversationId

String conversationId

dnis

String dnis

eventDateTime

Date eventDateTime

eventId

String eventId

initialConfiguration

InitialConfiguration initialConfiguration

phoneNumber

String phoneNumber

queueId

String queueId

sourceConfiguration

SourceConfiguration sourceConfiguration

stationId

String stationId

userId

String userId

Class com.mypurecloud.sdk.v2.model.UserExpands

class UserExpands extends Object implements Serializable

Serialized Fields

authorization

UserAuthorization authorization

conversationSummary

UserConversationSummary conversationSummary

geolocation

Geolocation geolocation

integrationPresence

UserPresence integrationPresence

outOfOffice

OutOfOffice outOfOffice

presence

UserPresence presence

routingStatus

RoutingStatus routingStatus

station

UserStations station

Class com.mypurecloud.sdk.v2.model.UserExternalIdentifier

class UserExternalIdentifier extends Object implements Serializable

Serialized Fields

authorityName

String authorityName

externalKey

String externalKey

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.UserGreetingEventGreeting

class UserGreetingEventGreeting extends Object implements Serializable

Serialized Fields

audioTTS

String audioTTS

greetingAudioFile

UserGreetingEventGreetingAudioFile greetingAudioFile

id

String id

name

String name

owner

UserGreetingEventGreetingOwner owner

ownerType

String ownerType

type

String type

Class com.mypurecloud.sdk.v2.model.UserGreetingEventGreetingAudioFile

class UserGreetingEventGreetingAudioFile extends Object implements Serializable

Serialized Fields

durationMilliseconds

Integer durationMilliseconds

sizeBytes

Integer sizeBytes

Class com.mypurecloud.sdk.v2.model.UserGreetingEventGreetingOwner

class UserGreetingEventGreetingOwner extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.UserImage

class UserImage extends Object implements Serializable

Serialized Fields

imageUri

String imageUri

resolution

String resolution

Class com.mypurecloud.sdk.v2.model.UserInsightsTrend

class UserInsightsTrend extends Object implements Serializable

Serialized Fields

comparativePeriod

WorkdayPeriod comparativePeriod

division

DivisionReference division

entities

List<InsightsTrendMetricItem> entities

granularity

UserInsightsTrend.GranularityEnum granularity

performanceProfile

AddressableEntityRef performanceProfile

primaryPeriod

WorkdayPeriod primaryPeriod

total

InsightsTrendTotalItem total

user

UserReference user

Class com.mypurecloud.sdk.v2.model.UserLanguageEntityListing

class UserLanguageEntityListing extends Object implements Serializable

Serialized Fields

entities

List<UserRoutingLanguage> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.UserLicenses

class UserLicenses extends Object implements Serializable

Serialized Fields

id

String id

licenses

List<String> licenses

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.UserLicensesEntityListing

class UserLicensesEntityListing extends Object implements Serializable

Serialized Fields

entities

List<UserLicenses> entities

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

total

Long total

Class com.mypurecloud.sdk.v2.model.UserListScheduleRequestBody

class UserListScheduleRequestBody extends Object implements Serializable

Serialized Fields

endDate

Date endDate

loadFullWeeks

Boolean loadFullWeeks

startDate

Date startDate

userIds

List<String> userIds

Class com.mypurecloud.sdk.v2.model.UserMe

class UserMe extends Object implements Serializable

Serialized Fields

acdAutoAnswer

Boolean acdAutoAnswer

addresses

List<Contact> addresses

adjacents

Adjacents adjacents

authorization

UserAuthorization authorization

biography

Biography biography

certifications

List<String> certifications

chat

Chat chat

conversationSummary

UserConversationSummary conversationSummary

date

ServerDate date

dateLastLogin

Date dateLastLogin

department

String department

directReports

List<User> directReports

division

Division division

divisionedPresenceDefinitions

List<OrganizationPresenceDefinition> divisionedPresenceDefinitions

email

String email

employerInfo

EmployerInfo employerInfo

favorites

List<User> favorites

fieldConfigs

FieldConfigs fieldConfigs

geolocation

Geolocation geolocation

geolocationSettings

GeolocationSettings geolocationSettings

groups

List<Group> groups

id

String id

images

List<UserImage> images

integrationPresence

UserPresence integrationPresence

languagePreference

String languagePreference

languages

List<UserRoutingLanguage> languages

lastTokenIssued

OAuthLastTokenIssued lastTokenIssued

locationDefinitions

List<LocationDefinition> locationDefinitions

locations

List<Location> locations

manager

User manager

name

String name

organization

Organization organization

orgAuthorization

List<DomainOrganizationRole> orgAuthorization

orgProducts

List<DomainOrganizationProduct> orgProducts

outOfOffice

OutOfOffice outOfOffice

presence

UserPresence presence

presenceDefinitions

List<OrganizationPresence> presenceDefinitions

primaryContactInfo

List<Contact> primaryContactInfo

profileSkills

List<String> profileSkills

routingSkills

List<RoutingSkill> routingSkills

routingStatus

RoutingStatus routingStatus

selfUri

String selfUri

skills

List<UserRoutingSkill> skills

state

UserMe.StateEnum state

station

UserStations station

superiors

List<User> superiors

team

Team team

title

String title

token

TokenInfo token

trustors

List<Trustor> trustors

username

String username

version

Integer version

Class com.mypurecloud.sdk.v2.model.UserObservationDataContainer

class UserObservationDataContainer extends Object implements Serializable

Serialized Fields

data

List<ObservationMetricData> data

group

Map<String,String> group

Class com.mypurecloud.sdk.v2.model.UserObservationQuery

class UserObservationQuery extends Object implements Serializable

Serialized Fields

detailMetrics

List<UserObservationQuery.DetailMetricsEnum> detailMetrics

filter

UserObservationQueryFilter filter

metrics

List<UserObservationQuery.MetricsEnum> metrics

Class com.mypurecloud.sdk.v2.model.UserObservationQueryClause

class UserObservationQueryClause extends Object implements Serializable

Serialized Fields

predicates

List<UserObservationQueryPredicate> predicates

type

UserObservationQueryClause.TypeEnum type

Class com.mypurecloud.sdk.v2.model.UserObservationQueryFilter

class UserObservationQueryFilter extends Object implements Serializable

Serialized Fields

clauses

List<UserObservationQueryClause> clauses

predicates

List<UserObservationQueryPredicate> predicates

type

UserObservationQueryFilter.TypeEnum type

Class com.mypurecloud.sdk.v2.model.UserObservationQueryPredicate

class UserObservationQueryPredicate extends Object implements Serializable

Serialized Fields

dimension

UserObservationQueryPredicate.DimensionEnum dimension

operator

UserObservationQueryPredicate.OperatorEnum operator

range

NumericRange range

type

UserObservationQueryPredicate.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.UserObservationQueryResponse

class UserObservationQueryResponse extends Object implements Serializable

Serialized Fields

results

List<UserObservationDataContainer> results

Class com.mypurecloud.sdk.v2.model.UserParam

class UserParam extends Object implements Serializable

Serialized Fields

key

String key

value

String value

Class com.mypurecloud.sdk.v2.model.UserPresence

class UserPresence extends Object implements Serializable

Serialized Fields

id

String id

message

String message

modifiedDate

Date modifiedDate

name

String name

presenceDefinition

PresenceDefinition presenceDefinition

primary

Boolean primary

selfUri

String selfUri

source

String source

Class com.mypurecloud.sdk.v2.model.UserPresenceEvent

class UserPresenceEvent extends Object implements Serializable

Serialized Fields

eventDateTime

Date eventDateTime

eventId

String eventId

message

String message

presenceDefinitionId

String presenceDefinitionId

sourceId

String sourceId

userId

String userId

Class com.mypurecloud.sdk.v2.model.UserPrimarySource

class UserPrimarySource extends Object implements Serializable

Serialized Fields

id

String id

name

String name

registered

Boolean registered

selfUri

String selfUri

sourceId

String sourceId

Class com.mypurecloud.sdk.v2.model.UserProfile

class UserProfile extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

expands

UserExpands expands

id

String id

name

String name

selfUri

String selfUri

state

UserProfile.StateEnum state

version

Long version

Class com.mypurecloud.sdk.v2.model.UserProfileEntityListing

class UserProfileEntityListing extends Object implements Serializable

Serialized Fields

entities

List<UserProfile> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.UserProfilesInDateRange

class UserProfilesInDateRange extends Object implements Serializable

Serialized Fields

dateEndWorkday

LocalDate dateEndWorkday

dateStartWorkday

LocalDate dateStartWorkday

profiles

List<ProfileWithDateRange> profiles

user

UserReference user

Class com.mypurecloud.sdk.v2.model.UserProfilesInDateRangeRequest

class UserProfilesInDateRangeRequest extends Object implements Serializable

Serialized Fields

endWorkday

String endWorkday

startWorkday

String startWorkday

Class com.mypurecloud.sdk.v2.model.UserQueue

class UserQueue extends Object implements Serializable

Serialized Fields

acwSettings

AcwSettings acwSettings

agentOwnedRouting

AgentOwnedRouting agentOwnedRouting

bullseye

Bullseye bullseye

callingPartyName

String callingPartyName

callingPartyNumber

String callingPartyNumber

createdBy

String createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

defaultScripts

Map<String,Script> defaultScripts

description

String description

directRouting

DirectRouting directRouting

division

Division division

emailInQueueFlow

DomainEntityRef emailInQueueFlow

enableManualAssignment

Boolean enableManualAssignment

enableTranscription

Boolean enableTranscription

id

String id

joined

Boolean joined

joinedMemberCount

Integer joinedMemberCount

mediaSettings

QueueMediaSettings mediaSettings

memberCount

Integer memberCount

memberGroups

List<MemberGroup> memberGroups

messageInQueueFlow

DomainEntityRef messageInQueueFlow

modifiedBy

String modifiedBy

name

String name

onHoldPrompt

DomainEntityRef onHoldPrompt

outboundEmailAddress

QueueEmailAddress outboundEmailAddress

outboundMessagingAddresses

QueueMessagingAddresses outboundMessagingAddresses

peerId

String peerId

queueFlow

DomainEntityRef queueFlow

routingRules

List<RoutingRule> routingRules

selfUri

String selfUri

skillEvaluationMethod

UserQueue.SkillEvaluationMethodEnum skillEvaluationMethod

userMemberCount

Integer userMemberCount

whisperPrompt

DomainEntityRef whisperPrompt

Class com.mypurecloud.sdk.v2.model.UserQueueEntityListing

class UserQueueEntityListing extends Object implements Serializable

Serialized Fields

entities

List<UserQueue> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.UserRecording

class UserRecording extends Object implements Serializable

Serialized Fields

contentLength

Long contentLength

contentUri

String contentUri

conversation

Conversation conversation

createdBy

DomainEntityRef createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

durationMilliseconds

Long durationMilliseconds

id

String id

name

String name

read

Boolean read

selfUri

String selfUri

thumbnails

List<DocumentThumbnail> thumbnails

workspace

DomainEntityRef workspace

Class com.mypurecloud.sdk.v2.model.UserRecordingEntityListing

class UserRecordingEntityListing extends Object implements Serializable

Serialized Fields

entities

List<UserRecording> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.UserReference

class UserReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.UserReferenceWithName

class UserReferenceWithName extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.UserRoutingLanguage

class UserRoutingLanguage extends Object implements Serializable

Serialized Fields

id

String id

languageUri

String languageUri

name

String name

proficiency

Double proficiency

selfUri

String selfUri

state

UserRoutingLanguage.StateEnum state

Class com.mypurecloud.sdk.v2.model.UserRoutingLanguagePost

class UserRoutingLanguagePost extends Object implements Serializable

Serialized Fields

id

String id

languageUri

String languageUri

proficiency

Double proficiency

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.UserRoutingSkill

class UserRoutingSkill extends Object implements Serializable

Serialized Fields

id

String id

name

String name

proficiency

Double proficiency

selfUri

String selfUri

skillUri

String skillUri

state

UserRoutingSkill.StateEnum state

Class com.mypurecloud.sdk.v2.model.UserRoutingSkillPost

class UserRoutingSkillPost extends Object implements Serializable

Serialized Fields

id

String id

proficiency

Double proficiency

selfUri

String selfUri

skillUri

String skillUri

Class com.mypurecloud.sdk.v2.model.UserRoutingStatusErrorInfo

class UserRoutingStatusErrorInfo extends Object implements Serializable

Serialized Fields

correlationId

String correlationId

errorCode

String errorCode

status

Integer status

userMessage

String userMessage

userParams

List<UserRoutingStatusUserParam> userParams

userParamsMessage

String userParamsMessage

Class com.mypurecloud.sdk.v2.model.UserRoutingStatusEvent

class UserRoutingStatusEvent extends Object implements Serializable

Serialized Fields

agentId

String agentId

eventDateTime

Date eventDateTime

eventId

String eventId

sourceId

String sourceId

status

UserRoutingStatusEvent.StatusEnum status

Class com.mypurecloud.sdk.v2.model.UserRoutingStatusObject

class UserRoutingStatusObject extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.UserRoutingStatusRoutingStatus

class UserRoutingStatusRoutingStatus extends Object implements Serializable

Serialized Fields

startTime

Date startTime

status

UserRoutingStatusRoutingStatus.StatusEnum status

Class com.mypurecloud.sdk.v2.model.UserRoutingStatusUserParam

class UserRoutingStatusUserParam extends Object implements Serializable

Serialized Fields

additionalProperties

Map<String,Object> additionalProperties

key

String key

value

String value

Class com.mypurecloud.sdk.v2.model.UserRoutingStatusUserRoutingStatus

class UserRoutingStatusUserRoutingStatus extends Object implements Serializable

Serialized Fields

errorInfo

UserRoutingStatusErrorInfo errorInfo

id

String id

routingStatus

UserRoutingStatusRoutingStatus routingStatus

Class com.mypurecloud.sdk.v2.model.UserSchedule

class UserSchedule extends Object implements Serializable

Serialized Fields

delete

Boolean delete

fullDayTimeOffMarkers

List<UserScheduleFullDayTimeOffMarker> fullDayTimeOffMarkers

metadata

WfmVersionedEntityMetadata metadata

shifts

List<UserScheduleShift> shifts

workPlanId

String workPlanId

Class com.mypurecloud.sdk.v2.model.UserScheduleActivity

class UserScheduleActivity extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

countsAsPaidTime

Boolean countsAsPaidTime

description

String description

isDstFallback

Boolean isDstFallback

lengthInMinutes

Integer lengthInMinutes

startDate

Date startDate

timeOffRequestId

String timeOffRequestId

Class com.mypurecloud.sdk.v2.model.UserScheduleAdherence

class UserScheduleAdherence extends Object implements Serializable

Serialized Fields

activeQueues

List<QueueReference> activeQueues

activeQueuesModifiedTime

Date activeQueuesModifiedTime

actualActivityCategory

UserScheduleAdherence.ActualActivityCategoryEnum actualActivityCategory

adherenceExplanation

RealTimeAdherenceExplanation adherenceExplanation

adherenceState

UserScheduleAdherence.AdherenceStateEnum adherenceState

businessUnit

BusinessUnitReference businessUnit

id

String id

impact

UserScheduleAdherence.ImpactEnum impact

isOutOfOffice

Boolean isOutOfOffice

managementUnit

ManagementUnitReference managementUnit

name

String name

organizationSecondaryPresenceId

String organizationSecondaryPresenceId

presenceUpdateTime

Date presenceUpdateTime

removedFromManagementUnit

Boolean removedFromManagementUnit

routingStatus

UserScheduleAdherence.RoutingStatusEnum routingStatus

scheduledActivityCategory

UserScheduleAdherence.ScheduledActivityCategoryEnum scheduledActivityCategory

scheduledActivityCode

ActivityCodeReference scheduledActivityCode

selfUri

String selfUri

systemPresence

UserScheduleAdherence.SystemPresenceEnum systemPresence

team

TeamReference team

timeOfAdherenceChange

Date timeOfAdherenceChange

user

UserReference user

Class com.mypurecloud.sdk.v2.model.UserScheduleAdherenceListing

class UserScheduleAdherenceListing extends Object implements Serializable

Serialized Fields

downloadUrl

String downloadUrl

entities

List<UserScheduleAdherence> entities

Class com.mypurecloud.sdk.v2.model.UserScheduleContainer

class UserScheduleContainer extends Object implements Serializable

Serialized Fields

managementUnitTimeZone

String managementUnitTimeZone

publishedSchedules

List<WeekScheduleReference> publishedSchedules

userSchedules

Map<String,UserSchedule> userSchedules

Class com.mypurecloud.sdk.v2.model.UserScheduleFullDayTimeOffMarker

class UserScheduleFullDayTimeOffMarker extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

delete

Boolean delete

description

String description

isPaid

Boolean isPaid

lengthInMinutes

Integer lengthInMinutes

managementUnitDate

String managementUnitDate

Class com.mypurecloud.sdk.v2.model.UserScheduleShift

class UserScheduleShift extends Object implements Serializable

Serialized Fields

activities

List<UserScheduleActivity> activities

delete

Boolean delete

id

String id

lengthInMinutes

Integer lengthInMinutes

manuallyEdited

Boolean manuallyEdited

startDate

Date startDate

weekSchedule

WeekScheduleReference weekSchedule

Class com.mypurecloud.sdk.v2.model.UserSearchCriteria

class UserSearchCriteria extends Object implements Serializable

Serialized Fields

dateFormat

String dateFormat

endValue

String endValue

fields

List<String> fields

group

List<UserSearchCriteria> group

operator

UserSearchCriteria.OperatorEnum operator

startValue

String startValue

type

UserSearchCriteria.TypeEnum type

value

String value

values

List<String> values

Class com.mypurecloud.sdk.v2.model.UserSearchRequest

class UserSearchRequest extends Object implements Serializable

Serialized Fields

enforcePermissions

Boolean enforcePermissions

expand

List<String> expand

integrationPresenceSource

UserSearchRequest.IntegrationPresenceSourceEnum integrationPresenceSource

pageNumber

Integer pageNumber

pageSize

Integer pageSize

query

List<UserSearchCriteria> query

sort

List<SearchSort> sort

sortBy

String sortBy

sortOrder

UserSearchRequest.SortOrderEnum sortOrder

Class com.mypurecloud.sdk.v2.model.UserSkillEntityListing

class UserSkillEntityListing extends Object implements Serializable

Serialized Fields

entities

List<UserRoutingSkill> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.UserSkillGroupEntityListing

class UserSkillGroupEntityListing extends Object implements Serializable

Serialized Fields

entities

List<SkillGroup> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.UsersSearchResponse

class UsersSearchResponse extends Object implements Serializable

Serialized Fields

currentPage

String currentPage

nextPage

String nextPage

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousPage

String previousPage

results

List<User> results

total

Long total

types

List<String> types

Class com.mypurecloud.sdk.v2.model.UserStartDetailEventTopicUserStartEvent

class UserStartDetailEventTopicUserStartEvent extends Object implements Serializable

Serialized Fields

addressFrom

String addressFrom

addressTo

String addressTo

ani

String ani

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Integer callbackScheduledTime

callbackUserName

String callbackUserName

conversationExternalContactIds

List<String> conversationExternalContactIds

conversationExternalOrganizationIds

List<String> conversationExternalOrganizationIds

conversationId

String conversationId

direction

UserStartDetailEventTopicUserStartEvent.DirectionEnum direction

divisionId

String divisionId

dnis

String dnis

eventTime

Integer eventTime

mediaType

UserStartDetailEventTopicUserStartEvent.MediaTypeEnum mediaType

messageType

UserStartDetailEventTopicUserStartEvent.MessageTypeEnum messageType

participantId

String participantId

provider

String provider

queueId

String queueId

sessionId

String sessionId

subject

String subject

userId

String userId

Class com.mypurecloud.sdk.v2.model.UserState

class UserState extends Object implements Serializable

Serialized Fields

state

UserState.StateEnum state

stateChangeDate

Date stateChangeDate

stateChangeReason

UserState.StateChangeReasonEnum stateChangeReason

version

Integer version

Class com.mypurecloud.sdk.v2.model.UserStation

class UserStation extends Object implements Serializable

Serialized Fields

associatedDate

Date associatedDate

associatedUser

User associatedUser

defaultUser

User defaultUser

id

String id

name

String name

providerInfo

Map<String,String> providerInfo

type

String type

webRtcCallAppearances

Integer webRtcCallAppearances

Class com.mypurecloud.sdk.v2.model.UserStationChangeTopicUser

class UserStationChangeTopicUser extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.UserStationChangeTopicUserStation

class UserStationChangeTopicUserStation extends Object implements Serializable

Serialized Fields

associatedUser

UserStationChangeTopicUser associatedUser

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.UserStationChangeTopicUserStations

class UserStationChangeTopicUserStations extends Object implements Serializable

Serialized Fields

associatedStation

UserStationChangeTopicUserStation associatedStation

Class com.mypurecloud.sdk.v2.model.UserStations

class UserStations extends Object implements Serializable

Serialized Fields

associatedStation

UserStation associatedStation

defaultStation

UserStation defaultStation

effectiveStation

UserStation effectiveStation

lastAssociatedStation

UserStation lastAssociatedStation

Class com.mypurecloud.sdk.v2.model.UserTimeOffRequestReference

class UserTimeOffRequestReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

user

UserReference user

Class com.mypurecloud.sdk.v2.model.UserTokensTopicTokenNotification

class UserTokensTopicTokenNotification extends Object implements Serializable

Serialized Fields

clientId

String clientId

dateCreated

String dateCreated

ipAddress

String ipAddress

sessionId

String sessionId

tokenExpirationDate

String tokenExpirationDate

tokenHash

String tokenHash

user

UserTokensTopicUriReference user

Class com.mypurecloud.sdk.v2.model.UserTokensTopicUriReference

class UserTokensTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.UserTransferEvent

class UserTransferEvent extends Object implements Serializable

Serialized Fields

commandId

String commandId

conversationId

String conversationId

destinationUserId

String destinationUserId

eventDateTime

Date eventDateTime

eventId

String eventId

initiatingCommunicationId

String initiatingCommunicationId

objectCommunicationId

String objectCommunicationId

targetCommunicationId

String targetCommunicationId

transferType

UserTransferEvent.TransferTypeEnum transferType

Class com.mypurecloud.sdk.v2.model.Utilization

class Utilization extends Object implements Serializable

Serialized Fields

utilization

Map<String,MediaUtilization> utilization

Class com.mypurecloud.sdk.v2.model.UtilizationTag

class UtilizationTag extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.UtilizationTagEntityListing

class UtilizationTagEntityListing extends Object implements Serializable

Serialized Fields

entities

List<UtilizationTag> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.Utterance

class Utterance extends Object implements Serializable

Serialized Fields

utteranceText

String utteranceText

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationButtonComponent

class V2ConversationMessageTypingEventForUserTopicConversationButtonComponent extends Object implements Serializable

Serialized Fields

actions

V2ConversationMessageTypingEventForUserTopicConversationContentActions actions

title

String title

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationContentActions

class V2ConversationMessageTypingEventForUserTopicConversationContentActions extends Object implements Serializable

Serialized Fields

textback

String textback

url

String url

urlTarget

String urlTarget

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationContentAttachment

class V2ConversationMessageTypingEventForUserTopicConversationContentAttachment extends Object implements Serializable

Serialized Fields

filename

String filename

id

String id

mediaType

V2ConversationMessageTypingEventForUserTopicConversationContentAttachment.MediaTypeEnum mediaType

mime

String mime

sha256

String sha256

text

String text

url

String url

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationContentButtonResponse

class V2ConversationMessageTypingEventForUserTopicConversationContentButtonResponse extends Object implements Serializable

Serialized Fields

payload

String payload

text

String text

type

V2ConversationMessageTypingEventForUserTopicConversationContentButtonResponse.TypeEnum type

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationContentGeneric

class V2ConversationMessageTypingEventForUserTopicConversationContentGeneric extends Object implements Serializable

Serialized Fields

actions

V2ConversationMessageTypingEventForUserTopicConversationContentActions actions

components

List<V2ConversationMessageTypingEventForUserTopicConversationButtonComponent> components

description

String description

image

String image

title

String title

video

String video

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationContentLocation

class V2ConversationMessageTypingEventForUserTopicConversationContentLocation extends Object implements Serializable

Serialized Fields

address

String address

latitude

BigDecimal latitude

longitude

BigDecimal longitude

text

String text

url

String url

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationContentNotificationTemplate

class V2ConversationMessageTypingEventForUserTopicConversationContentNotificationTemplate extends Object implements Serializable

Serialized Fields

body

V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateBody body

footer

V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateFooter footer

header

V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateHeader header

id

String id

language

String language

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationContentQuickReply

class V2ConversationMessageTypingEventForUserTopicConversationContentQuickReply extends Object implements Serializable

Serialized Fields

action

V2ConversationMessageTypingEventForUserTopicConversationContentQuickReply.ActionEnum action

image

String image

payload

String payload

text

String text

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationContentStory

class V2ConversationMessageTypingEventForUserTopicConversationContentStory extends Object implements Serializable

Serialized Fields

replyToId

String replyToId

type

V2ConversationMessageTypingEventForUserTopicConversationContentStory.TypeEnum type

url

String url

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationEventCoBrowse

class V2ConversationMessageTypingEventForUserTopicConversationEventCoBrowse extends Object implements Serializable

Serialized Fields

sessionId

String sessionId

sessionJoinToken

String sessionJoinToken

type

V2ConversationMessageTypingEventForUserTopicConversationEventCoBrowse.TypeEnum type

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationEventTyping

class V2ConversationMessageTypingEventForUserTopicConversationEventTyping extends Object implements Serializable

Serialized Fields

duration

Integer duration

type

V2ConversationMessageTypingEventForUserTopicConversationEventTyping.TypeEnum type

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationMessageContent

class V2ConversationMessageTypingEventForUserTopicConversationMessageContent extends Object implements Serializable

Serialized Fields

attachment

V2ConversationMessageTypingEventForUserTopicConversationContentAttachment attachment

buttonResponse

V2ConversationMessageTypingEventForUserTopicConversationContentButtonResponse buttonResponse

contentType

V2ConversationMessageTypingEventForUserTopicConversationMessageContent.ContentTypeEnum contentType

generic

V2ConversationMessageTypingEventForUserTopicConversationContentGeneric generic

location

V2ConversationMessageTypingEventForUserTopicConversationContentLocation location

quickReply

V2ConversationMessageTypingEventForUserTopicConversationContentQuickReply quickReply

story

V2ConversationMessageTypingEventForUserTopicConversationContentStory story

template

V2ConversationMessageTypingEventForUserTopicConversationContentNotificationTemplate template

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationMessageEvent

class V2ConversationMessageTypingEventForUserTopicConversationMessageEvent extends Object implements Serializable

Serialized Fields

coBrowse

V2ConversationMessageTypingEventForUserTopicConversationEventCoBrowse coBrowse

eventType

V2ConversationMessageTypingEventForUserTopicConversationMessageEvent.EventTypeEnum eventType

typing

V2ConversationMessageTypingEventForUserTopicConversationEventTyping typing

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationMessagingChannel

class V2ConversationMessageTypingEventForUserTopicConversationMessagingChannel extends Object implements Serializable

Serialized Fields

dateDeleted

Date dateDeleted

dateModified

Date dateModified

from

V2ConversationMessageTypingEventForUserTopicConversationMessagingFromRecipient from

id

String id

messageId

String messageId

metadata

V2ConversationMessageTypingEventForUserTopicConversationMessagingChannelMetadata metadata

platform

V2ConversationMessageTypingEventForUserTopicConversationMessagingChannel.PlatformEnum platform

time

Date time

to

V2ConversationMessageTypingEventForUserTopicConversationMessagingToRecipient to

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationMessagingChannelMetadata

class V2ConversationMessageTypingEventForUserTopicConversationMessagingChannelMetadata extends Object implements Serializable

Serialized Fields

customAttributes

Map<String,String> customAttributes

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationMessagingFromRecipient

class V2ConversationMessageTypingEventForUserTopicConversationMessagingFromRecipient extends Object implements Serializable

Serialized Fields

additionalIds

List<V2ConversationMessageTypingEventForUserTopicConversationRecipientAdditionalIdentifier> additionalIds

email

String email

firstName

String firstName

id

String id

idType

V2ConversationMessageTypingEventForUserTopicConversationMessagingFromRecipient.IdTypeEnum idType

image

String image

lastName

String lastName

nickname

String nickname

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationMessagingToRecipient

class V2ConversationMessageTypingEventForUserTopicConversationMessagingToRecipient extends Object implements Serializable

Serialized Fields

additionalIds

List<V2ConversationMessageTypingEventForUserTopicConversationRecipientAdditionalIdentifier> additionalIds

email

String email

firstName

String firstName

id

String id

idType

V2ConversationMessageTypingEventForUserTopicConversationMessagingToRecipient.IdTypeEnum idType

image

String image

lastName

String lastName

nickname

String nickname

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationNormalizedMessage

class V2ConversationMessageTypingEventForUserTopicConversationNormalizedMessage extends Object implements Serializable

Serialized Fields

channel

V2ConversationMessageTypingEventForUserTopicConversationMessagingChannel channel

content

List<V2ConversationMessageTypingEventForUserTopicConversationMessageContent> content

direction

V2ConversationMessageTypingEventForUserTopicConversationNormalizedMessage.DirectionEnum direction

events

List<V2ConversationMessageTypingEventForUserTopicConversationMessageEvent> events

id

String id

isFinalReceipt

Boolean isFinalReceipt

metadata

Map<String,String> metadata

originatingEntity

V2ConversationMessageTypingEventForUserTopicConversationNormalizedMessage.OriginatingEntityEnum originatingEntity

reasons

List<V2ConversationMessageTypingEventForUserTopicConversationReason> reasons

status

V2ConversationMessageTypingEventForUserTopicConversationNormalizedMessage.StatusEnum status

text

String text

type

V2ConversationMessageTypingEventForUserTopicConversationNormalizedMessage.TypeEnum type

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateBody

class V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateBody extends Object implements Serializable

Serialized Fields

parameters

List<V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateParameter> parameters

text

String text

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateFooter

class V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateFooter extends Object implements Serializable

Serialized Fields

text

String text

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateHeader

class V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateHeader extends Object implements Serializable

Serialized Fields

media

V2ConversationMessageTypingEventForUserTopicConversationContentAttachment media

parameters

List<V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateParameter> parameters

text

String text

type

V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateHeader.TypeEnum type

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateParameter

class V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateParameter extends Object implements Serializable

Serialized Fields

name

String name

text

String text

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationReason

class V2ConversationMessageTypingEventForUserTopicConversationReason extends Object implements Serializable

Serialized Fields

code

V2ConversationMessageTypingEventForUserTopicConversationReason.CodeEnum code

message

String message

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicConversationRecipientAdditionalIdentifier

class V2ConversationMessageTypingEventForUserTopicConversationRecipientAdditionalIdentifier extends Object implements Serializable

Serialized Fields

type

V2ConversationMessageTypingEventForUserTopicConversationRecipientAdditionalIdentifier.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForUserTopicMessageData

class V2ConversationMessageTypingEventForUserTopicMessageData extends Object implements Serializable

Serialized Fields

conversationId

String conversationId

normalizedMessage

V2ConversationMessageTypingEventForUserTopicConversationNormalizedMessage normalizedMessage

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationButtonComponent

class V2ConversationMessageTypingEventForWorkflowTopicConversationButtonComponent extends Object implements Serializable

Serialized Fields

actions

V2ConversationMessageTypingEventForWorkflowTopicConversationContentActions actions

title

String title

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationContentActions

class V2ConversationMessageTypingEventForWorkflowTopicConversationContentActions extends Object implements Serializable

Serialized Fields

textback

String textback

url

String url

urlTarget

String urlTarget

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationContentAttachment

class V2ConversationMessageTypingEventForWorkflowTopicConversationContentAttachment extends Object implements Serializable

Serialized Fields

filename

String filename

id

String id

mediaType

V2ConversationMessageTypingEventForWorkflowTopicConversationContentAttachment.MediaTypeEnum mediaType

mime

String mime

sha256

String sha256

text

String text

url

String url

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationContentButtonResponse

class V2ConversationMessageTypingEventForWorkflowTopicConversationContentButtonResponse extends Object implements Serializable

Serialized Fields

payload

String payload

text

String text

type

V2ConversationMessageTypingEventForWorkflowTopicConversationContentButtonResponse.TypeEnum type

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationContentGeneric

class V2ConversationMessageTypingEventForWorkflowTopicConversationContentGeneric extends Object implements Serializable

Serialized Fields

actions

V2ConversationMessageTypingEventForWorkflowTopicConversationContentActions actions

components

List<V2ConversationMessageTypingEventForWorkflowTopicConversationButtonComponent> components

description

String description

image

String image

title

String title

video

String video

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationContentLocation

class V2ConversationMessageTypingEventForWorkflowTopicConversationContentLocation extends Object implements Serializable

Serialized Fields

address

String address

latitude

BigDecimal latitude

longitude

BigDecimal longitude

text

String text

url

String url

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationContentNotificationTemplate

class V2ConversationMessageTypingEventForWorkflowTopicConversationContentNotificationTemplate extends Object implements Serializable

Serialized Fields

body

V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateBody body

footer

V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateFooter footer

header

V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateHeader header

id

String id

language

String language

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationContentQuickReply

class V2ConversationMessageTypingEventForWorkflowTopicConversationContentQuickReply extends Object implements Serializable

Serialized Fields

action

V2ConversationMessageTypingEventForWorkflowTopicConversationContentQuickReply.ActionEnum action

image

String image

payload

String payload

text

String text

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationContentStory

class V2ConversationMessageTypingEventForWorkflowTopicConversationContentStory extends Object implements Serializable

Serialized Fields

replyToId

String replyToId

type

V2ConversationMessageTypingEventForWorkflowTopicConversationContentStory.TypeEnum type

url

String url

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationEventCoBrowse

class V2ConversationMessageTypingEventForWorkflowTopicConversationEventCoBrowse extends Object implements Serializable

Serialized Fields

sessionId

String sessionId

sessionJoinToken

String sessionJoinToken

type

V2ConversationMessageTypingEventForWorkflowTopicConversationEventCoBrowse.TypeEnum type

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationEventTyping

class V2ConversationMessageTypingEventForWorkflowTopicConversationEventTyping extends Object implements Serializable

Serialized Fields

duration

Integer duration

type

V2ConversationMessageTypingEventForWorkflowTopicConversationEventTyping.TypeEnum type

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationMessageContent

class V2ConversationMessageTypingEventForWorkflowTopicConversationMessageContent extends Object implements Serializable

Serialized Fields

attachment

V2ConversationMessageTypingEventForWorkflowTopicConversationContentAttachment attachment

buttonResponse

V2ConversationMessageTypingEventForWorkflowTopicConversationContentButtonResponse buttonResponse

contentType

V2ConversationMessageTypingEventForWorkflowTopicConversationMessageContent.ContentTypeEnum contentType

generic

V2ConversationMessageTypingEventForWorkflowTopicConversationContentGeneric generic

location

V2ConversationMessageTypingEventForWorkflowTopicConversationContentLocation location

quickReply

V2ConversationMessageTypingEventForWorkflowTopicConversationContentQuickReply quickReply

story

V2ConversationMessageTypingEventForWorkflowTopicConversationContentStory story

template

V2ConversationMessageTypingEventForWorkflowTopicConversationContentNotificationTemplate template

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationMessageEvent

class V2ConversationMessageTypingEventForWorkflowTopicConversationMessageEvent extends Object implements Serializable

Serialized Fields

coBrowse

V2ConversationMessageTypingEventForWorkflowTopicConversationEventCoBrowse coBrowse

eventType

V2ConversationMessageTypingEventForWorkflowTopicConversationMessageEvent.EventTypeEnum eventType

typing

V2ConversationMessageTypingEventForWorkflowTopicConversationEventTyping typing

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingChannel

class V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingChannel extends Object implements Serializable

Serialized Fields

dateDeleted

Date dateDeleted

dateModified

Date dateModified

from

V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingFromRecipient from

id

String id

messageId

String messageId

metadata

V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingChannelMetadata metadata

platform

V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingChannel.PlatformEnum platform

time

Date time

to

V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingToRecipient to

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingChannelMetadata

class V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingChannelMetadata extends Object implements Serializable

Serialized Fields

customAttributes

Map<String,String> customAttributes

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingFromRecipient

class V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingFromRecipient extends Object implements Serializable

Serialized Fields

additionalIds

List<V2ConversationMessageTypingEventForWorkflowTopicConversationRecipientAdditionalIdentifier> additionalIds

email

String email

firstName

String firstName

id

String id

idType

V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingFromRecipient.IdTypeEnum idType

image

String image

lastName

String lastName

nickname

String nickname

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingToRecipient

class V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingToRecipient extends Object implements Serializable

Serialized Fields

additionalIds

List<V2ConversationMessageTypingEventForWorkflowTopicConversationRecipientAdditionalIdentifier> additionalIds

email

String email

firstName

String firstName

id

String id

idType

V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingToRecipient.IdTypeEnum idType

image

String image

lastName

String lastName

nickname

String nickname

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationNormalizedMessage

class V2ConversationMessageTypingEventForWorkflowTopicConversationNormalizedMessage extends Object implements Serializable

Serialized Fields

channel

V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingChannel channel

content

List<V2ConversationMessageTypingEventForWorkflowTopicConversationMessageContent> content

direction

V2ConversationMessageTypingEventForWorkflowTopicConversationNormalizedMessage.DirectionEnum direction

events

List<V2ConversationMessageTypingEventForWorkflowTopicConversationMessageEvent> events

id

String id

isFinalReceipt

Boolean isFinalReceipt

metadata

Map<String,String> metadata

originatingEntity

V2ConversationMessageTypingEventForWorkflowTopicConversationNormalizedMessage.OriginatingEntityEnum originatingEntity

reasons

List<V2ConversationMessageTypingEventForWorkflowTopicConversationReason> reasons

status

V2ConversationMessageTypingEventForWorkflowTopicConversationNormalizedMessage.StatusEnum status

text

String text

type

V2ConversationMessageTypingEventForWorkflowTopicConversationNormalizedMessage.TypeEnum type

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateBody

class V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateBody extends Object implements Serializable

Serialized Fields

parameters

List<V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateParameter> parameters

text

String text

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateFooter

class V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateFooter extends Object implements Serializable

Serialized Fields

text

String text

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateHeader

class V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateHeader extends Object implements Serializable

Serialized Fields

media

V2ConversationMessageTypingEventForWorkflowTopicConversationContentAttachment media

parameters

List<V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateParameter> parameters

text

String text

type

V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateHeader.TypeEnum type

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateParameter

class V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateParameter extends Object implements Serializable

Serialized Fields

name

String name

text

String text

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationReason

class V2ConversationMessageTypingEventForWorkflowTopicConversationReason extends Object implements Serializable

Serialized Fields

code

V2ConversationMessageTypingEventForWorkflowTopicConversationReason.CodeEnum code

message

String message

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicConversationRecipientAdditionalIdentifier

class V2ConversationMessageTypingEventForWorkflowTopicConversationRecipientAdditionalIdentifier extends Object implements Serializable

Serialized Fields

type

V2ConversationMessageTypingEventForWorkflowTopicConversationRecipientAdditionalIdentifier.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.V2ConversationMessageTypingEventForWorkflowTopicMessageData

class V2ConversationMessageTypingEventForWorkflowTopicMessageData extends Object implements Serializable

Serialized Fields

conversationId

String conversationId

normalizedMessage

V2ConversationMessageTypingEventForWorkflowTopicConversationNormalizedMessage normalizedMessage

Class com.mypurecloud.sdk.v2.model.V2MobiusAlertsTopicAlert

class V2MobiusAlertsTopicAlert extends Object implements Serializable

Serialized Fields

action

V2MobiusAlertsTopicAlert.ActionEnum action

active

Boolean active

additionalProperties

Map<String,String> additionalProperties

conditions

V2MobiusAlertsTopicCondition conditions

dateEnd

Date dateEnd

dateMutedUntil

Date dateMutedUntil

dateSnoozedUntil

Date dateSnoozedUntil

dateStart

Date dateStart

id

String id

muted

Boolean muted

notifications

List<V2MobiusAlertsTopicAlertNotification> notifications

rule

V2MobiusAlertsTopicAlertRuleProperties rule

snoozed

Boolean snoozed

unread

Boolean unread

userId

String userId

Class com.mypurecloud.sdk.v2.model.V2MobiusAlertsTopicAlertNotification

class V2MobiusAlertsTopicAlertNotification extends Object implements Serializable

Serialized Fields

notificationTypes

List<V2MobiusAlertsTopicAlertNotification.NotificationTypesEnum> notificationTypes

recipient

String recipient

Class com.mypurecloud.sdk.v2.model.V2MobiusAlertsTopicAlertRuleProperties

class V2MobiusAlertsTopicAlertRuleProperties extends Object implements Serializable

Serialized Fields

id

String id

name

String name

type

V2MobiusAlertsTopicAlertRuleProperties.TypeEnum type

Class com.mypurecloud.sdk.v2.model.V2MobiusAlertsTopicCondition

class V2MobiusAlertsTopicCondition extends Object implements Serializable

Serialized Fields

conditions

List<V2MobiusAlertsTopicCondition> conditions

predicates

List<V2MobiusAlertsTopicConditionRulePredicate> predicates

type

V2MobiusAlertsTopicCondition.TypeEnum type

Class com.mypurecloud.sdk.v2.model.V2MobiusAlertsTopicConditionRulePredicate

class V2MobiusAlertsTopicConditionRulePredicate extends Object implements Serializable

Serialized Fields

comparisonOperator

V2MobiusAlertsTopicConditionRulePredicate.ComparisonOperatorEnum comparisonOperator

entity

V2MobiusAlertsTopicEntityProperties entity

metric

String metric

metricType

V2MobiusAlertsTopicConditionRulePredicate.MetricTypeEnum metricType

metricValueType

V2MobiusAlertsTopicConditionRulePredicate.MetricValueTypeEnum metricValueType

value

BigDecimal value

Class com.mypurecloud.sdk.v2.model.V2MobiusAlertsTopicEntityProperties

class V2MobiusAlertsTopicEntityProperties extends Object implements Serializable

Serialized Fields

entityType

V2MobiusAlertsTopicEntityProperties.EntityTypeEnum entityType

groupDisplayName

String groupDisplayName

queueDisplayName

String queueDisplayName

userDisplayName

String userDisplayName

Class com.mypurecloud.sdk.v2.model.V2MobiusRulesTopicAlertNotification

class V2MobiusRulesTopicAlertNotification extends Object implements Serializable

Serialized Fields

notificationTypes

List<V2MobiusRulesTopicAlertNotification.NotificationTypesEnum> notificationTypes

recipient

String recipient

Class com.mypurecloud.sdk.v2.model.V2MobiusRulesTopicCondition

class V2MobiusRulesTopicCondition extends Object implements Serializable

Serialized Fields

conditions

List<V2MobiusRulesTopicCondition> conditions

predicates

List<V2MobiusRulesTopicConditionRulePredicate> predicates

type

V2MobiusRulesTopicCondition.TypeEnum type

Class com.mypurecloud.sdk.v2.model.V2MobiusRulesTopicConditionRulePredicate

class V2MobiusRulesTopicConditionRulePredicate extends Object implements Serializable

Serialized Fields

comparisonOperator

V2MobiusRulesTopicConditionRulePredicate.ComparisonOperatorEnum comparisonOperator

entity

V2MobiusRulesTopicEntityProperties entity

metric

String metric

metricType

V2MobiusRulesTopicConditionRulePredicate.MetricTypeEnum metricType

metricValueType

V2MobiusRulesTopicConditionRulePredicate.MetricValueTypeEnum metricValueType

value

BigDecimal value

Class com.mypurecloud.sdk.v2.model.V2MobiusRulesTopicEntityProperties

class V2MobiusRulesTopicEntityProperties extends Object implements Serializable

Serialized Fields

entityType

V2MobiusRulesTopicEntityProperties.EntityTypeEnum entityType

groupDisplayName

String groupDisplayName

queueDisplayName

String queueDisplayName

userDisplayName

String userDisplayName

Class com.mypurecloud.sdk.v2.model.V2MobiusRulesTopicRule

class V2MobiusRulesTopicRule extends Object implements Serializable

Serialized Fields

action

V2MobiusRulesTopicRule.ActionEnum action

conditions

V2MobiusRulesTopicCondition conditions

enabled

Boolean enabled

id

String id

inAlarm

Boolean inAlarm

name

String name

notifications

List<V2MobiusRulesTopicAlertNotification> notifications

type

V2MobiusRulesTopicRule.TypeEnum type

userId

String userId

Class com.mypurecloud.sdk.v2.model.ValidateAddressRequest

class ValidateAddressRequest extends Object implements Serializable

Serialized Fields

address

StreetAddress address

Class com.mypurecloud.sdk.v2.model.ValidateAddressResponse

class ValidateAddressResponse extends Object implements Serializable

Serialized Fields

response

SubscriberResponse response

valid

Boolean valid

Class com.mypurecloud.sdk.v2.model.ValidateAssignUsers

class ValidateAssignUsers extends Object implements Serializable

Serialized Fields

membersToAssign

List<String> membersToAssign

Class com.mypurecloud.sdk.v2.model.ValidateWorkPlanMessages

class ValidateWorkPlanMessages extends Object implements Serializable

Serialized Fields

constraintConflictMessage

ConstraintConflictMessage constraintConflictMessage

violationMessages

List<WorkPlanConfigurationViolationMessage> violationMessages

Class com.mypurecloud.sdk.v2.model.ValidateWorkPlanResponse

class ValidateWorkPlanResponse extends Object implements Serializable

Serialized Fields

messages

ValidateWorkPlanMessages messages

valid

Boolean valid

workPlan

WorkPlanReference workPlan

Class com.mypurecloud.sdk.v2.model.ValidationLimits

class ValidationLimits extends Object implements Serializable

Serialized Fields

maximum

MaxLength maximum

maxItems

MaxLength maxItems

maxLength

MaxLength maxLength

minimum

MinLength minimum

minItems

MinLength minItems

minLength

MinLength minLength

Class com.mypurecloud.sdk.v2.model.ValidationServiceRequest

class ValidationServiceRequest extends Object implements Serializable

Serialized Fields

dateImportEnded

Date dateImportEnded

uploadKey

String uploadKey

Class com.mypurecloud.sdk.v2.model.ValueWrapperDate

class ValueWrapperDate extends Object implements Serializable

Serialized Fields

value

Date value

Class com.mypurecloud.sdk.v2.model.ValueWrapperHrisTimeOffType

class ValueWrapperHrisTimeOffType extends Object implements Serializable

Serialized Fields

value

HrisTimeOffType value

Class com.mypurecloud.sdk.v2.model.ValueWrapperPlanningPeriodSettings

class ValueWrapperPlanningPeriodSettings extends Object implements Serializable

Serialized Fields

value

PlanningPeriodSettings value

Class com.mypurecloud.sdk.v2.model.ValueWrapperString

class ValueWrapperString extends Object implements Serializable

Serialized Fields

value

String value

Class com.mypurecloud.sdk.v2.model.VerificationResult

class VerificationResult extends Object implements Serializable

Serialized Fields

records

List<Record> records

status

VerificationResult.StatusEnum status

Class com.mypurecloud.sdk.v2.model.Video

class Video extends Object implements Serializable

Serialized Fields

afterCallWork

AfterCallWork afterCallWork

afterCallWorkRequired

Boolean afterCallWorkRequired

audioMuted

Boolean audioMuted

connectedTime

Date connectedTime

context

String context

disconnectedTime

Date disconnectedTime

disconnectType

Video.DisconnectTypeEnum disconnectType

id

String id

initialState

Video.InitialStateEnum initialState

msids

List<String> msids

peerCount

Integer peerCount

peerId

String peerId

provider

String provider

self

Address self

sharingScreen

Boolean sharingScreen

startAlertingTime

Date startAlertingTime

state

Video.StateEnum state

videoMuted

Boolean videoMuted

wrapup

Wrapup wrapup

Class com.mypurecloud.sdk.v2.model.VideoConferenceDetails

class VideoConferenceDetails extends Object implements Serializable

Serialized Fields

conferenceId

String conferenceId

conversationId

String conversationId

participantInfo

ParticipantInfo participantInfo

Class com.mypurecloud.sdk.v2.model.VideoConferenceUpdateTopicParticipantInfo

class VideoConferenceUpdateTopicParticipantInfo extends Object implements Serializable

Serialized Fields

activeParticipantCount

Integer activeParticipantCount

version

Integer version

Class com.mypurecloud.sdk.v2.model.VideoConferenceUpdateTopicVideoConference

class VideoConferenceUpdateTopicVideoConference extends Object implements Serializable

Serialized Fields

conferenceId

String conferenceId

conversationId

String conversationId

participantInfo

VideoConferenceUpdateTopicParticipantInfo participantInfo

Class com.mypurecloud.sdk.v2.model.ViewFilter

class ViewFilter extends Object implements Serializable

Serialized Fields

abandonDurationsMilliseconds

List<NumericRange> abandonDurationsMilliseconds

abandoned

Boolean abandoned

acdDurationsMilliseconds

List<NumericRange> acdDurationsMilliseconds

actionCategoryName

String actionCategoryName

acwDurationsMilliseconds

List<NumericRange> acwDurationsMilliseconds

addressFroms

List<String> addressFroms

addressTos

List<String> addressTos

agentCallbackOwnerIds

List<String> agentCallbackOwnerIds

alertRuleIds

List<String> alertRuleIds

aniList

List<String> aniList

answered

Boolean answered

availableDashboard

ViewFilter.AvailableDashboardEnum availableDashboard

blockedReasons

List<ViewFilter.BlockedReasonsEnum> blockedReasons

botFinalIntentList

List<String> botFinalIntentList

botIds

List<String> botIds

botIntentList

List<String> botIntentList

botMessageTypes

List<ViewFilter.BotMessageTypesEnum> botMessageTypes

botProductList

List<ViewFilter.BotProductListEnum> botProductList

botProviderList

List<ViewFilter.BotProviderListEnum> botProviderList

botRecognitionFailureReasonList

List<ViewFilter.BotRecognitionFailureReasonListEnum> botRecognitionFailureReasonList

botResultList

List<ViewFilter.BotResultListEnum> botResultList

botSlotList

List<String> botSlotList

botVersions

List<String> botVersions

callbackInterval

String callbackInterval

callbackNumberList

List<String> callbackNumberList

canonicalContactIds

List<String> canonicalContactIds

contactIds

List<String> contactIds

conversationIds

List<String> conversationIds

conversationInitiators

List<String> conversationInitiators

conversationProperties

ConversationProperties conversationProperties

customerSentimentScore

NumericRange customerSentimentScore

customerSentimentTrend

NumericRange customerSentimentTrend

dataActionIds

List<String> dataActionIds

developmentActivityOverdue

Boolean developmentActivityOverdue

developmentModuleIds

List<String> developmentModuleIds

developmentName

String developmentName

developmentRoleList

List<ViewFilter.DevelopmentRoleListEnum> developmentRoleList

developmentStatusList

List<ViewFilter.DevelopmentStatusListEnum> developmentStatusList

developmentTypeList

List<ViewFilter.DevelopmentTypeListEnum> developmentTypeList

directions

List<ViewFilter.DirectionsEnum> directions

divisionIds

List<String> divisionIds

dnisList

List<String> dnisList

durationsMilliseconds

List<NumericRange> durationsMilliseconds

emailDeliveryStatusList

List<ViewFilter.EmailDeliveryStatusListEnum> emailDeliveryStatusList

evaluatedAgentIds

List<String> evaluatedAgentIds

evaluationAssigned

Boolean evaluationAssigned

evaluationAssigneeIds

List<String> evaluationAssigneeIds

evaluationCriticalScore

NumericRange evaluationCriticalScore

evaluationFormContextIds

List<String> evaluationFormContextIds

evaluationFormIds

List<String> evaluationFormIds

evaluationScore

NumericRange evaluationScore

evaluationStatuses

List<ViewFilter.EvaluationStatusesEnum> evaluationStatuses

evaluatorIds

List<String> evaluatorIds

externalContactIds

List<String> externalContactIds

externalOrgIds

List<String> externalOrgIds

externalTags

List<String> externalTags

favouriteDashboard

Boolean favouriteDashboard

filterQueuesByUserIds

List<String> filterQueuesByUserIds

filterUsersByQueueIds

List<String> filterUsersByQueueIds

filterUsersByTeamIds

List<String> filterUsersByTeamIds

flowDestinationTypes

List<ViewFilter.FlowDestinationTypesEnum> flowDestinationTypes

flowDisconnectReasons

List<ViewFilter.FlowDisconnectReasonsEnum> flowDisconnectReasons

flowEntryReasons

List<String> flowEntryReasons

flowEntryTypes

List<ViewFilter.FlowEntryTypesEnum> flowEntryTypes

flowIds

List<String> flowIds

flowMilestoneIds

List<String> flowMilestoneIds

flowOutcomeIds

List<String> flowOutcomeIds

flowOutcomeValues

List<ViewFilter.FlowOutcomeValuesEnum> flowOutcomeValues

flowOutTypes

List<String> flowOutTypes

flowTransferTargets

List<String> flowTransferTargets

flowTypes

List<ViewFilter.FlowTypesEnum> flowTypes

flowVersions

List<String> flowVersions

groupIds

List<String> groupIds

handleDurationsMilliseconds

List<NumericRange> handleDurationsMilliseconds

hasAgentAssistId

Boolean hasAgentAssistId

hasCustomerParticipated

Boolean hasCustomerParticipated

hasEvaluation

Boolean hasEvaluation

hasFax

Boolean hasFax

hasJourneyActionMapId

Boolean hasJourneyActionMapId

hasJourneyCustomerId

Boolean hasJourneyCustomerId

hasJourneyVisitId

Boolean hasJourneyVisitId

hasMedia

Boolean hasMedia

hasScoredEvaluation

Boolean hasScoredEvaluation

hasSensitiveData

Boolean hasSensitiveData

holdDurationsMilliseconds

List<NumericRange> holdDurationsMilliseconds

integrationIds

List<String> integrationIds

isAcdInteraction

Boolean isAcdInteraction

isAgentOwnedCallback

Boolean isAgentOwnedCallback

isAnalyzedForSensitiveData

Boolean isAnalyzedForSensitiveData

isAssessmentPassed

Boolean isAssessmentPassed

isAuthenticated

Boolean isAuthenticated

isBlindTransferred

Boolean isBlindTransferred

isCampaign

Boolean isCampaign

isClearedByCustomer

Boolean isClearedByCustomer

isConsulted

Boolean isConsulted

isConsultTransferred

Boolean isConsultTransferred

isEnded

Boolean isEnded

isNotResponding

Boolean isNotResponding

isRecorded

Boolean isRecorded

isSurveyed

Boolean isSurveyed

journeyActionMapIds

List<String> journeyActionMapIds

journeyActionMapTypes

List<ViewFilter.JourneyActionMapTypesEnum> journeyActionMapTypes

journeyActionTargetIds

List<String> journeyActionTargetIds

journeyBlockingActionMapIds

List<String> journeyBlockingActionMapIds

journeyBlockingEmergencyScheduleGroupIds

List<String> journeyBlockingEmergencyScheduleGroupIds

journeyBlockingScheduleGroupIds

List<String> journeyBlockingScheduleGroupIds

journeyFrequencyCapReasons

List<String> journeyFrequencyCapReasons

journeyOutcomeIds

List<String> journeyOutcomeIds

journeySegmentIds

List<String> journeySegmentIds

journeyUrlContainsAllConditions

List<String> journeyUrlContainsAllConditions

journeyUrlContainsAnyConditions

List<String> journeyUrlContainsAnyConditions

journeyUrlEndsWithConditions

List<String> journeyUrlEndsWithConditions

journeyUrlEqualConditions

List<String> journeyUrlEqualConditions

journeyUrlNotContainsAllConditions

List<String> journeyUrlNotContainsAllConditions

journeyUrlNotContainsAnyConditions

List<String> journeyUrlNotContainsAnyConditions

journeyUrlNotEqualConditions

List<String> journeyUrlNotEqualConditions

journeyUrlStartsWithConditions

List<String> journeyUrlStartsWithConditions

languageGroups

List<String> languageGroups

languageIds

List<String> languageIds

locationIds

List<String> locationIds

managementUnitIds

List<String> managementUnitIds

mediaTypes

List<ViewFilter.MediaTypesEnum> mediaTypes

messageTypes

List<ViewFilter.MessageTypesEnum> messageTypes

mos

NumericRange mos

myDashboard

Boolean myDashboard

originatingDirections

List<ViewFilter.OriginatingDirectionsEnum> originatingDirections

outboundCampaignIds

List<String> outboundCampaignIds

outboundContactListIds

List<String> outboundContactListIds

participantPurposes

List<ViewFilter.ParticipantPurposesEnum> participantPurposes

promoterScores

List<NumericRange> promoterScores

providerList

List<String> providerList

queueIds

List<String> queueIds

remoteParticipants

List<String> remoteParticipants

reportsTos

List<String> reportsTos

requestedRoutingTypes

List<ViewFilter.RequestedRoutingTypesEnum> requestedRoutingTypes

responseStatuses

List<String> responseStatuses

roleIds

List<String> roleIds

sessionDnisList

List<String> sessionDnisList

showFirstQueue

Boolean showFirstQueue

sipCallIds

List<String> sipCallIds

skillGroups

List<String> skillGroups

skillIds

List<String> skillIds

stationErrors

List<String> stationErrors

subPath

String subPath

surveyFormContextIds

List<String> surveyFormContextIds

surveyFormIds

List<String> surveyFormIds

surveyNpsScore

NumericRange surveyNpsScore

surveyPromoterScore

NumericRange surveyPromoterScore

surveyQuestionGroupScore

NumericRange surveyQuestionGroupScore

surveyScores

List<NumericRange> surveyScores

surveyStatuses

List<String> surveyStatuses

surveyTotalScore

NumericRange surveyTotalScore

talkDurationsMilliseconds

List<NumericRange> talkDurationsMilliseconds

teamIds

List<String> teamIds

topicIds

List<String> topicIds

transcriptLanguages

List<String> transcriptLanguages

transcripts

List<Transcripts> transcripts

transcriptTopics

List<TranscriptTopics> transcriptTopics

transferred

Boolean transferred

usedRoutingTypes

List<ViewFilter.UsedRoutingTypesEnum> usedRoutingTypes

userIds

List<String> userIds

userState

ViewFilter.UserStateEnum userState

workbinIds

List<String> workbinIds

workitemAssigneeIds

List<String> workitemAssigneeIds

workitemIds

List<String> workitemIds

workitemStatuses

List<String> workitemStatuses

worktypeIds

List<String> worktypeIds

wrapUpCodes

List<String> wrapUpCodes

Class com.mypurecloud.sdk.v2.model.VisibilityCondition

class VisibilityCondition extends Object implements Serializable

Serialized Fields

combiningOperation

VisibilityCondition.CombiningOperationEnum combiningOperation

predicates

List<Object> predicates

Class com.mypurecloud.sdk.v2.model.VmPairingInfo

class VmPairingInfo extends Object implements Serializable

Serialized Fields

authToken

String authToken

edgeId

String edgeId

metaData

MetaData metaData

orgId

String orgId

Class com.mypurecloud.sdk.v2.model.Voicemail

class Voicemail extends Object implements Serializable

Serialized Fields

id

String id

uploadStatus

Voicemail.UploadStatusEnum uploadStatus

Class com.mypurecloud.sdk.v2.model.VoicemailCopyRecord

class VoicemailCopyRecord extends Object implements Serializable

Serialized Fields

date

Date date

group

Group group

user

User user

Class com.mypurecloud.sdk.v2.model.VoicemailEndDetailEventTopicVoicemailEndEvent

class VoicemailEndDetailEventTopicVoicemailEndEvent extends Object implements Serializable

Serialized Fields

ani

String ani

conversationExternalContactIds

List<String> conversationExternalContactIds

conversationExternalOrganizationIds

List<String> conversationExternalOrganizationIds

conversationId

String conversationId

direction

VoicemailEndDetailEventTopicVoicemailEndEvent.DirectionEnum direction

disconnectType

VoicemailEndDetailEventTopicVoicemailEndEvent.DisconnectTypeEnum disconnectType

divisionId

String divisionId

dnis

String dnis

eventTime

Integer eventTime

mediaType

VoicemailEndDetailEventTopicVoicemailEndEvent.MediaTypeEnum mediaType

participantId

String participantId

provider

String provider

queueId

String queueId

sessionId

String sessionId

userId

String userId

voicemailDurationMs

Integer voicemailDurationMs

Class com.mypurecloud.sdk.v2.model.VoicemailGroupPolicy

class VoicemailGroupPolicy extends Object implements Serializable

Serialized Fields

disableEmailPii

Boolean disableEmailPii

enabled

Boolean enabled

group

Group group

groupAlertType

VoicemailGroupPolicy.GroupAlertTypeEnum groupAlertType

includeEmailTranscriptions

Boolean includeEmailTranscriptions

interactiveResponsePromptId

String interactiveResponsePromptId

interactiveResponseRequired

Boolean interactiveResponseRequired

languagePreference

String languagePreference

name

String name

overflowGroupId

String overflowGroupId

rotateCallsSecs

Integer rotateCallsSecs

sendEmailNotifications

Boolean sendEmailNotifications

stopRingingAfterRotations

Integer stopRingingAfterRotations

Class com.mypurecloud.sdk.v2.model.VoicemailMailboxInfo

class VoicemailMailboxInfo extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

deletedCount

Integer deletedCount

modifiedDate

Date modifiedDate

totalCount

Integer totalCount

unreadCount

Integer unreadCount

usageSizeBytes

Long usageSizeBytes

Class com.mypurecloud.sdk.v2.model.VoicemailMediaInfo

class VoicemailMediaInfo extends Object implements Serializable

Serialized Fields

id

String id

mediaFileUri

String mediaFileUri

mediaImageUri

String mediaImageUri

waveformData

List<Float> waveformData

Class com.mypurecloud.sdk.v2.model.VoicemailMessage

class VoicemailMessage extends Object implements Serializable

Serialized Fields

audioRecordingDurationSeconds

Integer audioRecordingDurationSeconds

audioRecordingSizeBytes

Long audioRecordingSizeBytes

callerAddress

String callerAddress

callerName

String callerName

callerUser

User callerUser

conversation

Conversation conversation

copiedFrom

VoicemailCopyRecord copiedFrom

copiedTo

List<VoicemailCopyRecord> copiedTo

createdDate

Date createdDate

deleted

Boolean deleted

deletedDate

Date deletedDate

deleteRetentionPolicy

VoicemailRetentionPolicy deleteRetentionPolicy

group

Group group

id

String id

modifiedDate

Date modifiedDate

note

String note

queue

Queue queue

read

Boolean read

selfUri

String selfUri

user

User user

Class com.mypurecloud.sdk.v2.model.VoicemailMessageEntityListing

class VoicemailMessageEntityListing extends Object implements Serializable

Serialized Fields

entities

List<VoicemailMessage> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.VoicemailMessagesTopicOwner

class VoicemailMessagesTopicOwner extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.VoicemailMessagesTopicVoicemailCopyRecord

class VoicemailMessagesTopicVoicemailCopyRecord extends Object implements Serializable

Serialized Fields

group

VoicemailMessagesTopicOwner group

user

VoicemailMessagesTopicOwner user

Class com.mypurecloud.sdk.v2.model.VoicemailMessagesTopicVoicemailMessage

class VoicemailMessagesTopicVoicemailMessage extends Object implements Serializable

Serialized Fields

action

String action

audioRecordingDurationSeconds

Integer audioRecordingDurationSeconds

audioRecordingSizeBytes

Integer audioRecordingSizeBytes

callerAddress

String callerAddress

callerName

String callerName

copiedFrom

VoicemailMessagesTopicVoicemailCopyRecord copiedFrom

copiedTo

List<VoicemailMessagesTopicVoicemailCopyRecord> copiedTo

createdDate

Date createdDate

createdDateString

String createdDateString

deleted

Boolean deleted

id

String id

modifiedByUserId

String modifiedByUserId

modifiedDate

Date modifiedDate

modifiedDateString

String modifiedDateString

note

String note

read

Boolean read

Class com.mypurecloud.sdk.v2.model.VoicemailOrganizationPolicy

class VoicemailOrganizationPolicy extends Object implements Serializable

Serialized Fields

alertTimeoutSeconds

Integer alertTimeoutSeconds

disableEmailPii

Boolean disableEmailPii

enabled

Boolean enabled

includeEmailTranscriptions

Boolean includeEmailTranscriptions

interactiveResponseRequired

Boolean interactiveResponseRequired

maximumRecordingTimeSeconds

Integer maximumRecordingTimeSeconds

modifiedDate

Date modifiedDate

pinConfiguration

PINConfiguration pinConfiguration

pinRequired

Boolean pinRequired

sendEmailNotifications

Boolean sendEmailNotifications

voicemailExtension

String voicemailExtension

Class com.mypurecloud.sdk.v2.model.VoicemailRetentionPolicy

class VoicemailRetentionPolicy extends Object implements Serializable

Serialized Fields

numberOfDays

Integer numberOfDays

voicemailRetentionPolicyType

VoicemailRetentionPolicy.VoicemailRetentionPolicyTypeEnum voicemailRetentionPolicyType

Class com.mypurecloud.sdk.v2.model.VoicemailSearchCriteria

class VoicemailSearchCriteria extends Object implements Serializable

Serialized Fields

dateFormat

String dateFormat

endValue

String endValue

fields

List<String> fields

group

List<VoicemailSearchCriteria> group

operator

VoicemailSearchCriteria.OperatorEnum operator

startValue

String startValue

type

VoicemailSearchCriteria.TypeEnum type

value

String value

values

List<String> values

Class com.mypurecloud.sdk.v2.model.VoicemailSearchRequest

class VoicemailSearchRequest extends Object implements Serializable

Serialized Fields

expand

List<String> expand

pageNumber

Integer pageNumber

pageSize

Integer pageSize

query

List<VoicemailSearchCriteria> query

sort

List<SearchSort> sort

sortBy

String sortBy

sortOrder

VoicemailSearchRequest.SortOrderEnum sortOrder

Class com.mypurecloud.sdk.v2.model.VoicemailsSearchResponse

class VoicemailsSearchResponse extends Object implements Serializable

Serialized Fields

currentPage

String currentPage

nextPage

String nextPage

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousPage

String previousPage

results

List<VoicemailMessage> results

total

Long total

types

List<String> types

Class com.mypurecloud.sdk.v2.model.VoicemailStartDetailEventTopicVoicemailStartEvent

class VoicemailStartDetailEventTopicVoicemailStartEvent extends Object implements Serializable

Serialized Fields

ani

String ani

conversationExternalContactIds

List<String> conversationExternalContactIds

conversationExternalOrganizationIds

List<String> conversationExternalOrganizationIds

conversationId

String conversationId

direction

VoicemailStartDetailEventTopicVoicemailStartEvent.DirectionEnum direction

divisionId

String divisionId

dnis

String dnis

eventTime

Integer eventTime

mediaType

VoicemailStartDetailEventTopicVoicemailStartEvent.MediaTypeEnum mediaType

participantId

String participantId

provider

String provider

queueId

String queueId

sessionId

String sessionId

userId

String userId

Class com.mypurecloud.sdk.v2.model.VoicemailUserPolicy

class VoicemailUserPolicy extends Object implements Serializable

Serialized Fields

alertTimeoutSeconds

Integer alertTimeoutSeconds

enabled

Boolean enabled

modifiedDate

Date modifiedDate

pin

String pin

sendEmailNotifications

Boolean sendEmailNotifications

Class com.mypurecloud.sdk.v2.model.WaitlistPosition

class WaitlistPosition extends Object implements Serializable

Serialized Fields

date

LocalDate date

timeOffLimit

TimeOffLimitReference timeOffLimit

timeOffRequest

TimeOffRequestReference timeOffRequest

waitlistPosition

Integer waitlistPosition

Class com.mypurecloud.sdk.v2.model.WaitlistPositionListing

class WaitlistPositionListing extends Object implements Serializable

Serialized Fields

entities

List<WaitlistPosition> entities

Class com.mypurecloud.sdk.v2.model.WebActionEvent

class WebActionEvent extends Object implements Serializable

Serialized Fields

action

EventAction action

actionMap

ActionEventActionMap actionMap

actionTarget

AddressableEntityRef actionTarget

browser

Browser browser

device

Device device

errorCode

String errorCode

errorMessage

String errorMessage

geolocation

JourneyGeolocation geolocation

ipAddress

String ipAddress

ipOrganization

String ipOrganization

mktCampaign

JourneyCampaign mktCampaign

timeToDisposition

Long timeToDisposition

userAgentString

String userAgentString

visitReferrer

Referrer visitReferrer

Class com.mypurecloud.sdk.v2.model.WebChatConfig

class WebChatConfig extends Object implements Serializable

Serialized Fields

webChatSkin

WebChatConfig.WebChatSkinEnum webChatSkin

Class com.mypurecloud.sdk.v2.model.WebChatConversation

class WebChatConversation extends Object implements Serializable

Serialized Fields

id

String id

member

WebChatMemberInfo member

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WebChatDeployment

class WebChatDeployment extends Object implements Serializable

Serialized Fields

allowedDomains

List<String> allowedDomains

authenticationRequired

Boolean authenticationRequired

authenticationUrl

String authenticationUrl

description

String description

disabled

Boolean disabled

flow

DomainEntityRef flow

id

String id

name

String name

selfUri

String selfUri

webChatConfig

WebChatConfig webChatConfig

Class com.mypurecloud.sdk.v2.model.WebChatDeploymentEntityListing

class WebChatDeploymentEntityListing extends Object implements Serializable

Serialized Fields

entities

List<WebChatDeployment> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.WebChatGuestMediaRequest

class WebChatGuestMediaRequest extends Object implements Serializable

Serialized Fields

communicationId

String communicationId

id

String id

name

String name

securityKey

String securityKey

selfUri

String selfUri

state

WebChatGuestMediaRequest.StateEnum state

types

List<WebChatGuestMediaRequest.TypesEnum> types

Class com.mypurecloud.sdk.v2.model.WebChatGuestMediaRequestEntityList

class WebChatGuestMediaRequestEntityList extends Object implements Serializable

Serialized Fields

entities

List<WebChatGuestMediaRequest> entities

Class com.mypurecloud.sdk.v2.model.WebChatMemberInfo

class WebChatMemberInfo extends Object implements Serializable

Serialized Fields

authenticatedGuest

Boolean authenticatedGuest

avatarImageUrl

String avatarImageUrl

customFields

Map<String,String> customFields

displayName

String displayName

email

String email

firstName

String firstName

id

String id

joinDate

Date joinDate

lastName

String lastName

leaveDate

Date leaveDate

phoneNumber

String phoneNumber

role

WebChatMemberInfo.RoleEnum role

state

WebChatMemberInfo.StateEnum state

Class com.mypurecloud.sdk.v2.model.WebChatMemberInfoEntityList

class WebChatMemberInfoEntityList extends Object implements Serializable

Serialized Fields

entities

List<WebChatMemberInfo> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.WebChatMessage

class WebChatMessage extends Object implements Serializable

Serialized Fields

body

String body

bodyType

WebChatMessage.BodyTypeEnum bodyType

conversation

WebChatConversation conversation

id

String id

name

String name

selfUri

String selfUri

sender

WebChatMemberInfo sender

timestamp

Date timestamp

Class com.mypurecloud.sdk.v2.model.WebChatMessageEntityList

class WebChatMessageEntityList extends Object implements Serializable

Serialized Fields

entities

List<WebChatMessage> entities

next

String next

pageSize

Integer pageSize

previousPage

String previousPage

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WebChatRoutingTarget

class WebChatRoutingTarget extends Object implements Serializable

Serialized Fields

language

String language

priority

Long priority

skills

List<String> skills

targetAddress

String targetAddress

targetType

WebChatRoutingTarget.TargetTypeEnum targetType

Class com.mypurecloud.sdk.v2.model.WebChatSettings

class WebChatSettings extends Object implements Serializable

Serialized Fields

requireDeployment

Boolean requireDeployment

Class com.mypurecloud.sdk.v2.model.WebChatTyping

class WebChatTyping extends Object implements Serializable

Serialized Fields

conversation

WebChatConversation conversation

id

String id

sender

WebChatMemberInfo sender

timestamp

Date timestamp

Class com.mypurecloud.sdk.v2.model.WebDeployment

class WebDeployment extends Object implements Serializable

Serialized Fields

_configuration

WebDeploymentConfigurationVersionEntityRef _configuration

allowAllDomains

Boolean allowAllDomains

allowedDomains

List<String> allowedDomains

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

flow

DomainEntityRef flow

id

String id

lastModifiedUser

AddressableEntityRef lastModifiedUser

name

String name

selfUri

String selfUri

snippet

String snippet

status

WebDeployment.StatusEnum status

supportedContentProfile

SupportedContentProfile supportedContentProfile

Class com.mypurecloud.sdk.v2.model.WebDeploymentActiveConfigurationOnDeployment

class WebDeploymentActiveConfigurationOnDeployment extends Object implements Serializable

Serialized Fields

configurationVersion

WebDeploymentConfigurationVersion configurationVersion

deployment

WebDeployment deployment

Class com.mypurecloud.sdk.v2.model.WebDeploymentConfigurationVersion

class WebDeploymentConfigurationVersion extends Object implements Serializable

Serialized Fields

authenticationSettings

AuthenticationSettings authenticationSettings

cobrowse

CobrowseSettings cobrowse

createdUser

AddressableEntityRef createdUser

customI18nLabels

List<CustomI18nLabels> customI18nLabels

dateCreated

Date dateCreated

dateModified

Date dateModified

datePublished

Date datePublished

defaultLanguage

String defaultLanguage

description

String description

headlessMode

WebDeploymentHeadlessMode headlessMode

id

String id

journeyEvents

JourneyEventsSettings journeyEvents

languages

List<String> languages

lastModifiedUser

AddressableEntityRef lastModifiedUser

messenger

MessengerSettings messenger

name

String name

position

PositionSettings position

publishedUser

AddressableEntityRef publishedUser

selfUri

String selfUri

status

WebDeploymentConfigurationVersion.StatusEnum status

supportCenter

SupportCenterSettings supportCenter

version

String version

Class com.mypurecloud.sdk.v2.model.WebDeploymentConfigurationVersionEntityListing

class WebDeploymentConfigurationVersionEntityListing extends Object implements Serializable

Serialized Fields

entities

List<WebDeploymentConfigurationVersion> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.WebDeploymentConfigurationVersionEntityRef

class WebDeploymentConfigurationVersionEntityRef extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

version

String version

Class com.mypurecloud.sdk.v2.model.WebDeploymentConfigurationVersionResponse

class WebDeploymentConfigurationVersionResponse extends Object implements Serializable

Serialized Fields

authenticationSettings

AuthenticationSettings authenticationSettings

cobrowse

CobrowseSettings cobrowse

createdUser

AddressableEntityRef createdUser

customI18nLabels

List<CustomI18nLabels> customI18nLabels

dateCreated

Date dateCreated

dateModified

Date dateModified

datePublished

Date datePublished

defaultLanguage

String defaultLanguage

description

String description

headlessMode

WebDeploymentHeadlessMode headlessMode

id

String id

journeyEvents

JourneyEventsSettings journeyEvents

languages

List<String> languages

lastModifiedUser

AddressableEntityRef lastModifiedUser

messenger

MessengerSettings messenger

name

String name

position

PositionSettings position

publishedUser

AddressableEntityRef publishedUser

selfUri

String selfUri

status

WebDeploymentConfigurationVersionResponse.StatusEnum status

supportCenter

SupportCenterSettings supportCenter

version

String version

Class com.mypurecloud.sdk.v2.model.WebDeploymentHeadlessMode

class WebDeploymentHeadlessMode extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

Class com.mypurecloud.sdk.v2.model.WebDeploymentsAuthorizationResponse

class WebDeploymentsAuthorizationResponse extends Object implements Serializable

Serialized Fields

jwt

String jwt

refreshToken

String refreshToken

Class com.mypurecloud.sdk.v2.model.WebDeploymentsConfigTopicWebMessagingConfigChangeEventBody

class WebDeploymentsConfigTopicWebMessagingConfigChangeEventBody extends Object implements Serializable

Serialized Fields

id

String id

status

WebDeploymentsConfigTopicWebMessagingConfigChangeEventBody.StatusEnum status

version

String version

Class com.mypurecloud.sdk.v2.model.WebDeploymentsDeploymentTopicWebMessagingConfigChangeEventBody

class WebDeploymentsDeploymentTopicWebMessagingConfigChangeEventBody extends Object implements Serializable

Serialized Fields

id

String id

status

WebDeploymentsDeploymentTopicWebMessagingConfigChangeEventBody.StatusEnum status

version

String version

Class com.mypurecloud.sdk.v2.model.WebDeploymentsDeploymentTopicWebMessagingDeploymentChangeEventBody

class WebDeploymentsDeploymentTopicWebMessagingDeploymentChangeEventBody extends Object implements Serializable

Serialized Fields

_configuration

WebDeploymentsDeploymentTopicWebMessagingConfigChangeEventBody _configuration

id

String id

status

WebDeploymentsDeploymentTopicWebMessagingDeploymentChangeEventBody.StatusEnum status

Class com.mypurecloud.sdk.v2.model.WebDeploymentsJourneyContext

class WebDeploymentsJourneyContext extends Object implements Serializable

Serialized Fields

customer

JourneyCustomer customer

customerSession

JourneyCustomerSession customerSession

Class com.mypurecloud.sdk.v2.model.WebDeploymentsOAuthExchangeRequest

class WebDeploymentsOAuthExchangeRequest extends Object implements Serializable

Serialized Fields

deploymentId

String deploymentId

journeyContext

WebDeploymentsJourneyContext journeyContext

oauth

WebDeploymentsOAuthRequestParameters oauth

Class com.mypurecloud.sdk.v2.model.WebDeploymentsOAuthRequestParameters

class WebDeploymentsOAuthRequestParameters extends Object implements Serializable

Serialized Fields

code

String code

codeVerifier

String codeVerifier

iss

String iss

maxAge

Integer maxAge

nonce

String nonce

redirectUri

String redirectUri

Class com.mypurecloud.sdk.v2.model.WebDeploymentsRefreshJWTRequest

class WebDeploymentsRefreshJWTRequest extends Object implements Serializable

Serialized Fields

deploymentId

String deploymentId

refreshToken

String refreshToken

Class com.mypurecloud.sdk.v2.model.WebEvent

class WebEvent extends Object implements Serializable

Serialized Fields

attributes

Map<String,CustomEventAttribute> attributes

authenticated

Boolean authenticated

browser

Browser browser

device

Device device

eventName

String eventName

geolocation

JourneyGeolocation geolocation

ipAddress

String ipAddress

ipOrganization

String ipOrganization

mktCampaign

JourneyCampaign mktCampaign

page

JourneyPage page

referrer

Referrer referrer

searchQuery

String searchQuery

totalEventCount

Integer totalEventCount

totalPageviewCount

Integer totalPageviewCount

traits

Map<String,CustomEventAttribute> traits

userAgentString

String userAgentString

Class com.mypurecloud.sdk.v2.model.WebMessagingAttachment

class WebMessagingAttachment extends Object implements Serializable

Serialized Fields

filename

String filename

fileSize

Integer fileSize

id

String id

mediaType

WebMessagingAttachment.MediaTypeEnum mediaType

mime

String mime

sha256

String sha256

text

String text

url

String url

Class com.mypurecloud.sdk.v2.model.WebMessagingButtonResponse

class WebMessagingButtonResponse extends Object implements Serializable

Serialized Fields

id

String id

payload

String payload

text

String text

type

WebMessagingButtonResponse.TypeEnum type

Class com.mypurecloud.sdk.v2.model.WebMessagingChannel

class WebMessagingChannel extends Object implements Serializable

Serialized Fields

from

WebMessagingRecipient from

messageId

String messageId

time

Date time

to

WebMessagingRecipient to

Class com.mypurecloud.sdk.v2.model.WebMessagingContent

class WebMessagingContent extends Object implements Serializable

Serialized Fields

attachment

WebMessagingAttachment attachment

buttonResponse

WebMessagingButtonResponse buttonResponse

card

ContentCard card

carousel

ContentCarousel carousel

contentType

WebMessagingContent.ContentTypeEnum contentType

generic

WebMessagingGeneric generic

quickReply

WebMessagingQuickReply quickReply

Class com.mypurecloud.sdk.v2.model.WebMessagingEvent

class WebMessagingEvent extends Object implements Serializable

Serialized Fields

coBrowse

WebMessagingEventCoBrowse coBrowse

eventType

WebMessagingEvent.EventTypeEnum eventType

presence

WebMessagingEventPresence presence

Class com.mypurecloud.sdk.v2.model.WebMessagingEventCoBrowse

class WebMessagingEventCoBrowse extends Object implements Serializable

Serialized Fields

sessionId

String sessionId

sessionJoinToken

String sessionJoinToken

type

WebMessagingEventCoBrowse.TypeEnum type

Class com.mypurecloud.sdk.v2.model.WebMessagingEventPresence

class WebMessagingEventPresence extends Object implements Serializable

Serialized Fields

type

WebMessagingEventPresence.TypeEnum type

Class com.mypurecloud.sdk.v2.model.WebMessagingGeneric

class WebMessagingGeneric extends Object implements Serializable

Serialized Fields

actions

ContentActions actions

components

List<ButtonComponent> components

description

String description

image

String image

title

String title

Class com.mypurecloud.sdk.v2.model.WebMessagingMessage

class WebMessagingMessage extends Object implements Serializable

Serialized Fields

channel

WebMessagingChannel channel

content

List<WebMessagingContent> content

direction

WebMessagingMessage.DirectionEnum direction

events

List<WebMessagingEvent> events

id

String id

metadata

Map<String,String> metadata

originatingEntity

WebMessagingMessage.OriginatingEntityEnum originatingEntity

text

String text

type

WebMessagingMessage.TypeEnum type

Class com.mypurecloud.sdk.v2.model.WebMessagingMessageEntityList

class WebMessagingMessageEntityList extends Object implements Serializable

Serialized Fields

entities

List<WebMessagingMessage> entities

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

total

Long total

Class com.mypurecloud.sdk.v2.model.WebMessagingOfferFields

class WebMessagingOfferFields extends Object implements Serializable

Serialized Fields

architectFlow

AddressableEntityRef architectFlow

offerText

String offerText

Class com.mypurecloud.sdk.v2.model.WebMessagingQuickReply

class WebMessagingQuickReply extends Object implements Serializable

Serialized Fields

action

WebMessagingQuickReply.ActionEnum action

image

String image

payload

String payload

text

String text

Class com.mypurecloud.sdk.v2.model.WebMessagingRecipient

class WebMessagingRecipient extends Object implements Serializable

Serialized Fields

additionalIds

List<RecipientAdditionalIdentifier> additionalIds

firstName

String firstName

image

String image

lastName

String lastName

nickname

String nickname

Class com.mypurecloud.sdk.v2.model.WeekSchedule

class WeekSchedule extends Object implements Serializable

Serialized Fields

agentSchedulesVersion

Integer agentSchedulesVersion

description

String description

generationResults

WeekScheduleGenerationResult generationResults

headcountForecast

HeadcountForecast headcountForecast

id

String id

metadata

WfmVersionedEntityMetadata metadata

published

Boolean published

selfUri

String selfUri

shortTermForecast

ShortTermForecastReference shortTermForecast

userSchedules

Map<String,UserSchedule> userSchedules

weekDate

String weekDate

Class com.mypurecloud.sdk.v2.model.WeekScheduleGenerationResult

class WeekScheduleGenerationResult extends Object implements Serializable

Serialized Fields

agentWarningCount

Integer agentWarningCount

agentWarnings

List<ScheduleGenerationWarning> agentWarnings

failed

Boolean failed

runId

String runId

Class com.mypurecloud.sdk.v2.model.WeekScheduleListItemResponse

class WeekScheduleListItemResponse extends Object implements Serializable

Serialized Fields

description

String description

generationResults

WeekScheduleGenerationResult generationResults

id

String id

metadata

WfmVersionedEntityMetadata metadata

published

Boolean published

selfUri

String selfUri

shortTermForecast

ShortTermForecastReference shortTermForecast

weekDate

String weekDate

Class com.mypurecloud.sdk.v2.model.WeekScheduleListResponse

class WeekScheduleListResponse extends Object implements Serializable

Serialized Fields

entities

List<WeekScheduleListItemResponse> entities

Class com.mypurecloud.sdk.v2.model.WeekScheduleReference

class WeekScheduleReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

weekDate

String weekDate

Class com.mypurecloud.sdk.v2.model.WeekScheduleResponse

class WeekScheduleResponse extends Object implements Serializable

Serialized Fields

downloadUrl

String downloadUrl

result

WeekSchedule result

Class com.mypurecloud.sdk.v2.model.WeekShiftTradeListResponse

class WeekShiftTradeListResponse extends Object implements Serializable

Serialized Fields

entities

List<WeekShiftTradeResponse> entities

Class com.mypurecloud.sdk.v2.model.WeekShiftTradeMatchesSummaryResponse

class WeekShiftTradeMatchesSummaryResponse extends Object implements Serializable

Serialized Fields

count

Integer count

weekDate

LocalDate weekDate

Class com.mypurecloud.sdk.v2.model.WeekShiftTradeResponse

class WeekShiftTradeResponse extends Object implements Serializable

Serialized Fields

matchReview

ShiftTradeMatchReviewResponse matchReview

trade

ShiftTradeResponse trade

Class com.mypurecloud.sdk.v2.model.WemCoachingUserNotificationTopicCoachingAppointmentReference

class WemCoachingUserNotificationTopicCoachingAppointmentReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WemCoachingUserNotificationTopicCoachingUserNotification

class WemCoachingUserNotificationTopicCoachingUserNotification extends Object implements Serializable

Serialized Fields

actionType

WemCoachingUserNotificationTopicCoachingUserNotification.ActionTypeEnum actionType

appointment

WemCoachingUserNotificationTopicCoachingAppointmentReference appointment

dateStart

Date dateStart

id

String id

lengthInMinutes

Integer lengthInMinutes

markedAsRead

Boolean markedAsRead

name

String name

relationship

WemCoachingUserNotificationTopicCoachingUserNotification.RelationshipEnum relationship

status

WemCoachingUserNotificationTopicCoachingUserNotification.StatusEnum status

Class com.mypurecloud.sdk.v2.model.WfmAgent

class WfmAgent extends Object implements Serializable

Serialized Fields

acceptDirectShiftTrades

Boolean acceptDirectShiftTrades

id

String id

languages

List<LanguageReference> languages

metadata

WfmVersionedEntityMetadata metadata

queues

List<QueueReference> queues

schedulable

Boolean schedulable

selfUri

String selfUri

skills

List<RoutingSkillReference> skills

user

UserReference user

workPlan

WorkPlanReference workPlan

workPlanRotation

WorkPlanRotationReference workPlanRotation

Class com.mypurecloud.sdk.v2.model.WfmAgentScheduleUpdateTopicAgentScheduleShiftUpdate

class WfmAgentScheduleUpdateTopicAgentScheduleShiftUpdate extends Object implements Serializable

Serialized Fields

shiftStartDates

List<Date> shiftStartDates

type

WfmAgentScheduleUpdateTopicAgentScheduleShiftUpdate.TypeEnum type

Class com.mypurecloud.sdk.v2.model.WfmAgentScheduleUpdateTopicAgentScheduleUpdateNotification

class WfmAgentScheduleUpdateTopicAgentScheduleUpdateNotification extends Object implements Serializable

Serialized Fields

endDate

Date endDate

startDate

Date startDate

updates

List<WfmAgentScheduleUpdateTopicAgentScheduleShiftUpdate> updates

user

WfmAgentScheduleUpdateTopicUserReference user

Class com.mypurecloud.sdk.v2.model.WfmAgentScheduleUpdateTopicUserReference

class WfmAgentScheduleUpdateTopicUserReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmBuIntradayDataUpdateTopicBuIntradayDataGroup

class WfmBuIntradayDataUpdateTopicBuIntradayDataGroup extends Object implements Serializable

Serialized Fields

forecastDataPerInterval

List<WfmBuIntradayDataUpdateTopicBuIntradayForecastData> forecastDataPerInterval

forecastDataSummary

WfmBuIntradayDataUpdateTopicBuIntradayForecastData forecastDataSummary

mediaType

WfmBuIntradayDataUpdateTopicBuIntradayDataGroup.MediaTypeEnum mediaType

performancePredictionDataPerInterval

List<WfmBuIntradayDataUpdateTopicIntradayPerformancePredictionData> performancePredictionDataPerInterval

performancePredictionDataSummary

WfmBuIntradayDataUpdateTopicIntradayPerformancePredictionData performancePredictionDataSummary

scheduleDataPerInterval

List<WfmBuIntradayDataUpdateTopicBuIntradayScheduleData> scheduleDataPerInterval

scheduleDataSummary

WfmBuIntradayDataUpdateTopicBuIntradayScheduleData scheduleDataSummary

Class com.mypurecloud.sdk.v2.model.WfmBuIntradayDataUpdateTopicBuIntradayForecastData

class WfmBuIntradayDataUpdateTopicBuIntradayForecastData extends Object implements Serializable

Serialized Fields

averageHandleTimeSeconds

BigDecimal averageHandleTimeSeconds

offered

BigDecimal offered

Class com.mypurecloud.sdk.v2.model.WfmBuIntradayDataUpdateTopicBuIntradayNotification

class WfmBuIntradayDataUpdateTopicBuIntradayNotification extends Object implements Serializable

Serialized Fields

operationId

String operationId

result

WfmBuIntradayDataUpdateTopicBuIntradayResult result

Class com.mypurecloud.sdk.v2.model.WfmBuIntradayDataUpdateTopicBuIntradayResult

class WfmBuIntradayDataUpdateTopicBuIntradayResult extends Object implements Serializable

Serialized Fields

categories

List<WfmBuIntradayDataUpdateTopicBuIntradayResult.CategoriesEnum> categories

endDate

Date endDate

intervalLengthMinutes

Integer intervalLengthMinutes

intradayDataGroupings

List<WfmBuIntradayDataUpdateTopicBuIntradayDataGroup> intradayDataGroupings

noDataReason

String noDataReason

schedule

WfmBuIntradayDataUpdateTopicBuScheduleReference schedule

shortTermForecast

WfmBuIntradayDataUpdateTopicBuShortTermForecastReference shortTermForecast

startDate

Date startDate

Class com.mypurecloud.sdk.v2.model.WfmBuIntradayDataUpdateTopicBuIntradayScheduleData

class WfmBuIntradayDataUpdateTopicBuIntradayScheduleData extends Object implements Serializable

Serialized Fields

onQueueTimeSeconds

Integer onQueueTimeSeconds

Class com.mypurecloud.sdk.v2.model.WfmBuIntradayDataUpdateTopicBuScheduleReference

class WfmBuIntradayDataUpdateTopicBuScheduleReference extends Object implements Serializable

Serialized Fields

id

String id

weekDate

Date weekDate

Class com.mypurecloud.sdk.v2.model.WfmBuIntradayDataUpdateTopicBuShortTermForecastReference

class WfmBuIntradayDataUpdateTopicBuShortTermForecastReference extends Object implements Serializable

Serialized Fields

description

String description

id

String id

weekDate

String weekDate

Class com.mypurecloud.sdk.v2.model.WfmBuIntradayDataUpdateTopicIntradayPerformancePredictionData

class WfmBuIntradayDataUpdateTopicIntradayPerformancePredictionData extends Object implements Serializable

Serialized Fields

averageSpeedOfAnswerSeconds

BigDecimal averageSpeedOfAnswerSeconds

occupancyPercent

BigDecimal occupancyPercent

serviceLevelPercent

BigDecimal serviceLevelPercent

Class com.mypurecloud.sdk.v2.model.WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateNotification

class WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateNotification extends Object implements Serializable

Serialized Fields

operationId

String operationId

result

WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateResultListing result

status

WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateNotification.StatusEnum status

weekDate

Date weekDate

Class com.mypurecloud.sdk.v2.model.WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateResult

class WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateResult extends Object implements Serializable

Serialized Fields

failureReason

WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateResult.FailureReasonEnum failureReason

id

String id

metadata

WfmBulkShiftTradeStateUpdateNotificationTopicWfmVersionedEntityMetadata metadata

reviewedBy

WfmBulkShiftTradeStateUpdateNotificationTopicUserReference reviewedBy

reviewedDate

Date reviewedDate

state

WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateResult.StateEnum state

Class com.mypurecloud.sdk.v2.model.WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateResultListing

class WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateResultListing extends Object implements Serializable

Serialized Fields

entities

List<WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateResult> entities

Class com.mypurecloud.sdk.v2.model.WfmBulkShiftTradeStateUpdateNotificationTopicUserReference

class WfmBulkShiftTradeStateUpdateNotificationTopicUserReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmBulkShiftTradeStateUpdateNotificationTopicWfmVersionedEntityMetadata

class WfmBulkShiftTradeStateUpdateNotificationTopicWfmVersionedEntityMetadata extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

modifiedBy

WfmBulkShiftTradeStateUpdateNotificationTopicUserReference modifiedBy

version

Integer version

Class com.mypurecloud.sdk.v2.model.WfmBuScheduleQueryResultTopicBuScheduleSearchResultNotification

class WfmBuScheduleQueryResultTopicBuScheduleSearchResultNotification extends Object implements Serializable

Serialized Fields

businessUnitId

String businessUnitId

downloadUrl

String downloadUrl

operationId

String operationId

Class com.mypurecloud.sdk.v2.model.WfmBuScheduleRunTopicBuScheduleReference

class WfmBuScheduleRunTopicBuScheduleReference extends Object implements Serializable

Serialized Fields

id

String id

weekDate

Date weekDate

Class com.mypurecloud.sdk.v2.model.WfmBuScheduleRunTopicBuScheduleRun

class WfmBuScheduleRunTopicBuScheduleRun extends Object implements Serializable

Serialized Fields

id

String id

intradayRescheduling

Boolean intradayRescheduling

messageCount

Integer messageCount

messageSeverityCounts

List<WfmBuScheduleRunTopicSchedulerMessageSeverityCount> messageSeverityCounts

percentComplete

BigDecimal percentComplete

schedule

WfmBuScheduleRunTopicBuScheduleReference schedule

schedulingCanceledBy

WfmBuScheduleRunTopicUserReference schedulingCanceledBy

schedulingCompletedTime

String schedulingCompletedTime

state

WfmBuScheduleRunTopicBuScheduleRun.StateEnum state

weekCount

Integer weekCount

Class com.mypurecloud.sdk.v2.model.WfmBuScheduleRunTopicBuSchedulingRunProgressNotification

class WfmBuScheduleRunTopicBuSchedulingRunProgressNotification extends Object implements Serializable

Serialized Fields

operationId

String operationId

result

WfmBuScheduleRunTopicBuScheduleRun result

status

WfmBuScheduleRunTopicBuSchedulingRunProgressNotification.StatusEnum status

Class com.mypurecloud.sdk.v2.model.WfmBuScheduleRunTopicSchedulerMessageSeverityCount

class WfmBuScheduleRunTopicSchedulerMessageSeverityCount extends Object implements Serializable

Serialized Fields

count

Integer count

severity

WfmBuScheduleRunTopicSchedulerMessageSeverityCount.SeverityEnum severity

Class com.mypurecloud.sdk.v2.model.WfmBuScheduleRunTopicUserReference

class WfmBuScheduleRunTopicUserReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmBuScheduleSearchResultTopicBuScheduleSearchResultNotification

class WfmBuScheduleSearchResultTopicBuScheduleSearchResultNotification extends Object implements Serializable

Serialized Fields

businessUnitId

String businessUnitId

downloadUrl

String downloadUrl

operationId

String operationId

Class com.mypurecloud.sdk.v2.model.WfmBuScheduleTopicBuManagementUnitScheduleSummary

class WfmBuScheduleTopicBuManagementUnitScheduleSummary extends Object implements Serializable

Serialized Fields

agentCount

Integer agentCount

agents

List<WfmBuScheduleTopicUserReference> agents

endDate

Date endDate

managementUnit

WfmBuScheduleTopicManagementUnit managementUnit

startDate

Date startDate

Class com.mypurecloud.sdk.v2.model.WfmBuScheduleTopicBuScheduleGenerationResultSummary

class WfmBuScheduleTopicBuScheduleGenerationResultSummary extends Object implements Serializable

Serialized Fields

failed

Boolean failed

messageCount

Integer messageCount

messageSeverityCounts

List<WfmBuScheduleTopicSchedulerMessageSeverityCount> messageSeverityCounts

runId

String runId

Class com.mypurecloud.sdk.v2.model.WfmBuScheduleTopicBuScheduleMetadata

class WfmBuScheduleTopicBuScheduleMetadata extends Object implements Serializable

Serialized Fields

description

String description

generationResults

WfmBuScheduleTopicBuScheduleGenerationResultSummary generationResults

id

String id

managementUnits

List<WfmBuScheduleTopicBuManagementUnitScheduleSummary> managementUnits

metadata

WfmBuScheduleTopicWfmVersionedEntityMetadata metadata

published

Boolean published

shortTermForecast

WfmBuScheduleTopicBuShortTermForecastReference shortTermForecast

weekCount

Integer weekCount

weekDate

Date weekDate

Class com.mypurecloud.sdk.v2.model.WfmBuScheduleTopicBuScheduleNotification

class WfmBuScheduleTopicBuScheduleNotification extends Object implements Serializable

Serialized Fields

eventType

WfmBuScheduleTopicBuScheduleNotification.EventTypeEnum eventType

operationId

String operationId

result

WfmBuScheduleTopicBuScheduleMetadata result

status

WfmBuScheduleTopicBuScheduleNotification.StatusEnum status

Class com.mypurecloud.sdk.v2.model.WfmBuScheduleTopicBuShortTermForecastReference

class WfmBuScheduleTopicBuShortTermForecastReference extends Object implements Serializable

Serialized Fields

description

String description

id

String id

weekDate

String weekDate

Class com.mypurecloud.sdk.v2.model.WfmBuScheduleTopicManagementUnit

class WfmBuScheduleTopicManagementUnit extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmBuScheduleTopicSchedulerMessageSeverityCount

class WfmBuScheduleTopicSchedulerMessageSeverityCount extends Object implements Serializable

Serialized Fields

count

Integer count

severity

WfmBuScheduleTopicSchedulerMessageSeverityCount.SeverityEnum severity

Class com.mypurecloud.sdk.v2.model.WfmBuScheduleTopicUserReference

class WfmBuScheduleTopicUserReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmBuScheduleTopicWfmVersionedEntityMetadata

class WfmBuScheduleTopicWfmVersionedEntityMetadata extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

modifiedBy

WfmBuScheduleTopicUserReference modifiedBy

version

Integer version

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastCopyCompleteTopicBuForecastModification

class WfmBuShortTermForecastCopyCompleteTopicBuForecastModification extends Object implements Serializable

Serialized Fields

displayGranularity

String displayGranularity

enabled

Boolean enabled

endIntervalIndex

Integer endIntervalIndex

granularity

String granularity

legacyMetric

WfmBuShortTermForecastCopyCompleteTopicBuForecastModification.LegacyMetricEnum legacyMetric

metric

WfmBuShortTermForecastCopyCompleteTopicBuForecastModification.MetricEnum metric

planningGroupIds

List<String> planningGroupIds

startIntervalIndex

Integer startIntervalIndex

type

WfmBuShortTermForecastCopyCompleteTopicBuForecastModification.TypeEnum type

value

BigDecimal value

values

List<WfmBuShortTermForecastCopyCompleteTopicModificationIntervalOffsetValue> values

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastCopyCompleteTopicBuShortTermForecast

class WfmBuShortTermForecastCopyCompleteTopicBuShortTermForecast extends Object implements Serializable

Serialized Fields

canUseForScheduling

Boolean canUseForScheduling

creationMethod

WfmBuShortTermForecastCopyCompleteTopicBuShortTermForecast.CreationMethodEnum creationMethod

description

String description

id

String id

legacy

Boolean legacy

metadata

WfmBuShortTermForecastCopyCompleteTopicWfmVersionedEntityMetadata metadata

modifications

List<WfmBuShortTermForecastCopyCompleteTopicBuForecastModification> modifications

planningGroupsVersion

Integer planningGroupsVersion

referenceStartDate

Date referenceStartDate

sourceDays

List<WfmBuShortTermForecastCopyCompleteTopicForecastSourceDayPointer> sourceDays

timeZone

String timeZone

weekCount

Integer weekCount

weekDate

String weekDate

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastCopyCompleteTopicBuShortTermForecastNotification

class WfmBuShortTermForecastCopyCompleteTopicBuShortTermForecastNotification extends Object implements Serializable

Serialized Fields

operationId

String operationId

result

WfmBuShortTermForecastCopyCompleteTopicBuShortTermForecast result

status

WfmBuShortTermForecastCopyCompleteTopicBuShortTermForecastNotification.StatusEnum status

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastCopyCompleteTopicForecastSourceDayPointer

class WfmBuShortTermForecastCopyCompleteTopicForecastSourceDayPointer extends Object implements Serializable

Serialized Fields

dataKey

String dataKey

date

String date

dayOfWeek

WfmBuShortTermForecastCopyCompleteTopicForecastSourceDayPointer.DayOfWeekEnum dayOfWeek

fileName

String fileName

weight

Integer weight

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastCopyCompleteTopicModificationIntervalOffsetValue

class WfmBuShortTermForecastCopyCompleteTopicModificationIntervalOffsetValue extends Object implements Serializable

Serialized Fields

intervalIndex

Integer intervalIndex

value

BigDecimal value

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastCopyCompleteTopicUserReference

class WfmBuShortTermForecastCopyCompleteTopicUserReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastCopyCompleteTopicWfmVersionedEntityMetadata

class WfmBuShortTermForecastCopyCompleteTopicWfmVersionedEntityMetadata extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

modifiedBy

WfmBuShortTermForecastCopyCompleteTopicUserReference modifiedBy

version

Integer version

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastGenerateProgressTopicBuForecastModification

class WfmBuShortTermForecastGenerateProgressTopicBuForecastModification extends Object implements Serializable

Serialized Fields

displayGranularity

String displayGranularity

enabled

Boolean enabled

endIntervalIndex

Integer endIntervalIndex

granularity

String granularity

legacyMetric

WfmBuShortTermForecastGenerateProgressTopicBuForecastModification.LegacyMetricEnum legacyMetric

metric

WfmBuShortTermForecastGenerateProgressTopicBuForecastModification.MetricEnum metric

planningGroupIds

List<String> planningGroupIds

startIntervalIndex

Integer startIntervalIndex

type

WfmBuShortTermForecastGenerateProgressTopicBuForecastModification.TypeEnum type

value

BigDecimal value

values

List<WfmBuShortTermForecastGenerateProgressTopicModificationIntervalOffsetValue> values

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastGenerateProgressTopicBuShortTermForecast

class WfmBuShortTermForecastGenerateProgressTopicBuShortTermForecast extends Object implements Serializable

Serialized Fields

canUseForScheduling

Boolean canUseForScheduling

creationMethod

WfmBuShortTermForecastGenerateProgressTopicBuShortTermForecast.CreationMethodEnum creationMethod

description

String description

id

String id

legacy

Boolean legacy

metadata

WfmBuShortTermForecastGenerateProgressTopicWfmVersionedEntityMetadata metadata

modifications

List<WfmBuShortTermForecastGenerateProgressTopicBuForecastModification> modifications

planningGroupsVersion

Integer planningGroupsVersion

referenceStartDate

Date referenceStartDate

sourceDays

List<WfmBuShortTermForecastGenerateProgressTopicForecastSourceDayPointer> sourceDays

timeZone

String timeZone

weekCount

Integer weekCount

weekDate

String weekDate

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastGenerateProgressTopicForecastSourceDayPointer

class WfmBuShortTermForecastGenerateProgressTopicForecastSourceDayPointer extends Object implements Serializable

Serialized Fields

dataKey

String dataKey

date

String date

dayOfWeek

WfmBuShortTermForecastGenerateProgressTopicForecastSourceDayPointer.DayOfWeekEnum dayOfWeek

fileName

String fileName

weight

Integer weight

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastGenerateProgressTopicGenerateBuShortTermForecastProgressNotification

class WfmBuShortTermForecastGenerateProgressTopicGenerateBuShortTermForecastProgressNotification extends Object implements Serializable

Serialized Fields

operationId

String operationId

progress

Integer progress

result

WfmBuShortTermForecastGenerateProgressTopicBuShortTermForecast result

status

WfmBuShortTermForecastGenerateProgressTopicGenerateBuShortTermForecastProgressNotification.StatusEnum status

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastGenerateProgressTopicModificationIntervalOffsetValue

class WfmBuShortTermForecastGenerateProgressTopicModificationIntervalOffsetValue extends Object implements Serializable

Serialized Fields

intervalIndex

Integer intervalIndex

value

BigDecimal value

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastGenerateProgressTopicUserReference

class WfmBuShortTermForecastGenerateProgressTopicUserReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastGenerateProgressTopicWfmVersionedEntityMetadata

class WfmBuShortTermForecastGenerateProgressTopicWfmVersionedEntityMetadata extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

modifiedBy

WfmBuShortTermForecastGenerateProgressTopicUserReference modifiedBy

version

Integer version

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastImportCompleteTopicBuForecastModification

class WfmBuShortTermForecastImportCompleteTopicBuForecastModification extends Object implements Serializable

Serialized Fields

displayGranularity

String displayGranularity

enabled

Boolean enabled

endIntervalIndex

Integer endIntervalIndex

granularity

String granularity

legacyMetric

WfmBuShortTermForecastImportCompleteTopicBuForecastModification.LegacyMetricEnum legacyMetric

metric

WfmBuShortTermForecastImportCompleteTopicBuForecastModification.MetricEnum metric

planningGroupIds

List<String> planningGroupIds

startIntervalIndex

Integer startIntervalIndex

type

WfmBuShortTermForecastImportCompleteTopicBuForecastModification.TypeEnum type

value

BigDecimal value

values

List<WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue> values

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast

class WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast extends Object implements Serializable

Serialized Fields

canUseForScheduling

Boolean canUseForScheduling

creationMethod

WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast.CreationMethodEnum creationMethod

description

String description

id

String id

legacy

Boolean legacy

metadata

WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata metadata

modifications

List<WfmBuShortTermForecastImportCompleteTopicBuForecastModification> modifications

planningGroupsVersion

Integer planningGroupsVersion

referenceStartDate

Date referenceStartDate

sourceDays

List<WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer> sourceDays

timeZone

String timeZone

weekCount

Integer weekCount

weekDate

String weekDate

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification

class WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification extends Object implements Serializable

Serialized Fields

operationId

String operationId

result

WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast result

status

WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification.StatusEnum status

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer

class WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer extends Object implements Serializable

Serialized Fields

dataKey

String dataKey

date

String date

dayOfWeek

WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer.DayOfWeekEnum dayOfWeek

fileName

String fileName

weight

Integer weight

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue

class WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue extends Object implements Serializable

Serialized Fields

intervalIndex

Integer intervalIndex

value

BigDecimal value

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastImportCompleteTopicUserReference

class WfmBuShortTermForecastImportCompleteTopicUserReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata

class WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

modifiedBy

WfmBuShortTermForecastImportCompleteTopicUserReference modifiedBy

version

Integer version

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastUpdateCompleteTopicBuForecastModification

class WfmBuShortTermForecastUpdateCompleteTopicBuForecastModification extends Object implements Serializable

Serialized Fields

displayGranularity

String displayGranularity

enabled

Boolean enabled

endIntervalIndex

Integer endIntervalIndex

granularity

String granularity

legacyMetric

WfmBuShortTermForecastUpdateCompleteTopicBuForecastModification.LegacyMetricEnum legacyMetric

metric

WfmBuShortTermForecastUpdateCompleteTopicBuForecastModification.MetricEnum metric

planningGroupIds

List<String> planningGroupIds

startIntervalIndex

Integer startIntervalIndex

type

WfmBuShortTermForecastUpdateCompleteTopicBuForecastModification.TypeEnum type

value

BigDecimal value

values

List<WfmBuShortTermForecastUpdateCompleteTopicModificationIntervalOffsetValue> values

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastUpdateCompleteTopicBuShortTermForecast

class WfmBuShortTermForecastUpdateCompleteTopicBuShortTermForecast extends Object implements Serializable

Serialized Fields

canUseForScheduling

Boolean canUseForScheduling

creationMethod

WfmBuShortTermForecastUpdateCompleteTopicBuShortTermForecast.CreationMethodEnum creationMethod

description

String description

id

String id

legacy

Boolean legacy

metadata

WfmBuShortTermForecastUpdateCompleteTopicWfmVersionedEntityMetadata metadata

modifications

List<WfmBuShortTermForecastUpdateCompleteTopicBuForecastModification> modifications

planningGroupsVersion

Integer planningGroupsVersion

referenceStartDate

Date referenceStartDate

sourceDays

List<WfmBuShortTermForecastUpdateCompleteTopicForecastSourceDayPointer> sourceDays

timeZone

String timeZone

weekCount

Integer weekCount

weekDate

String weekDate

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastUpdateCompleteTopicBuShortTermForecastNotification

class WfmBuShortTermForecastUpdateCompleteTopicBuShortTermForecastNotification extends Object implements Serializable

Serialized Fields

operationId

String operationId

result

WfmBuShortTermForecastUpdateCompleteTopicBuShortTermForecast result

status

WfmBuShortTermForecastUpdateCompleteTopicBuShortTermForecastNotification.StatusEnum status

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastUpdateCompleteTopicForecastSourceDayPointer

class WfmBuShortTermForecastUpdateCompleteTopicForecastSourceDayPointer extends Object implements Serializable

Serialized Fields

dataKey

String dataKey

date

String date

dayOfWeek

WfmBuShortTermForecastUpdateCompleteTopicForecastSourceDayPointer.DayOfWeekEnum dayOfWeek

fileName

String fileName

weight

Integer weight

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastUpdateCompleteTopicModificationIntervalOffsetValue

class WfmBuShortTermForecastUpdateCompleteTopicModificationIntervalOffsetValue extends Object implements Serializable

Serialized Fields

intervalIndex

Integer intervalIndex

value

BigDecimal value

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastUpdateCompleteTopicUserReference

class WfmBuShortTermForecastUpdateCompleteTopicUserReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmBuShortTermForecastUpdateCompleteTopicWfmVersionedEntityMetadata

class WfmBuShortTermForecastUpdateCompleteTopicWfmVersionedEntityMetadata extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

modifiedBy

WfmBuShortTermForecastUpdateCompleteTopicUserReference modifiedBy

version

Integer version

Class com.mypurecloud.sdk.v2.model.WfmBusinessUnitReference

class WfmBusinessUnitReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WfmForecastModificationIntervalOffsetValue

class WfmForecastModificationIntervalOffsetValue extends Object implements Serializable

Serialized Fields

intervalIndex

Integer intervalIndex

value

Double value

Class com.mypurecloud.sdk.v2.model.WfmHistoricalAdherenceBulkCalculationsCompleteTopicWfmHistoricalAdherenceBulkCalculationsCompleteNotification

class WfmHistoricalAdherenceBulkCalculationsCompleteTopicWfmHistoricalAdherenceBulkCalculationsCompleteNotification extends Object implements Serializable

Serialized Fields

downloadUrls

List<String> downloadUrls

id

String id

queryState

WfmHistoricalAdherenceBulkCalculationsCompleteTopicWfmHistoricalAdherenceBulkCalculationsCompleteNotification.QueryStateEnum queryState

Class com.mypurecloud.sdk.v2.model.WfmHistoricalAdherenceBulkItem

class WfmHistoricalAdherenceBulkItem extends Object implements Serializable

Serialized Fields

endDate

Date endDate

includeExceptions

Boolean includeExceptions

managementUnitId

String managementUnitId

startDate

Date startDate

userIds

List<String> userIds

Class com.mypurecloud.sdk.v2.model.WfmHistoricalAdherenceBulkJobReference

class WfmHistoricalAdherenceBulkJobReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

status

WfmHistoricalAdherenceBulkJobReference.StatusEnum status

Class com.mypurecloud.sdk.v2.model.WfmHistoricalAdherenceBulkQuery

class WfmHistoricalAdherenceBulkQuery extends Object implements Serializable

Serialized Fields

items

List<WfmHistoricalAdherenceBulkItem> items

timeZone

String timeZone

Class com.mypurecloud.sdk.v2.model.WfmHistoricalAdherenceBulkResponse

class WfmHistoricalAdherenceBulkResponse extends Object implements Serializable

Serialized Fields

downloadResult

WfmHistoricalAdherenceBulkResult downloadResult

downloadUrls

List<String> downloadUrls

job

WfmHistoricalAdherenceBulkJobReference job

Class com.mypurecloud.sdk.v2.model.WfmHistoricalAdherenceBulkResult

class WfmHistoricalAdherenceBulkResult extends Object implements Serializable

Serialized Fields

endDate

Date endDate

lookupIdToSecondaryPresenceId

Map<String,String> lookupIdToSecondaryPresenceId

managementUnitId

String managementUnitId

startDate

Date startDate

userResults

List<WfmHistoricalAdherenceBulkUserResult> userResults

Class com.mypurecloud.sdk.v2.model.WfmHistoricalAdherenceBulkUserDayMetrics

class WfmHistoricalAdherenceBulkUserDayMetrics extends Object implements Serializable

Serialized Fields

actualLengthSeconds

Integer actualLengthSeconds

adherencePercentage

Double adherencePercentage

adherenceScheduleSeconds

Integer adherenceScheduleSeconds

conformanceActualSeconds

Integer conformanceActualSeconds

conformancePercentage

Double conformancePercentage

conformanceScheduleSeconds

Integer conformanceScheduleSeconds

dayStartOffsetSeconds

Integer dayStartOffsetSeconds

exceptionCount

Integer exceptionCount

exceptionDurationSeconds

Integer exceptionDurationSeconds

impactSeconds

Integer impactSeconds

scheduleLengthSeconds

Integer scheduleLengthSeconds

Class com.mypurecloud.sdk.v2.model.WfmHistoricalAdherenceBulkUserResult

class WfmHistoricalAdherenceBulkUserResult extends Object implements Serializable

Serialized Fields

adherencePercentage

Double adherencePercentage

conformancePercentage

Double conformancePercentage

dayMetrics

List<WfmHistoricalAdherenceBulkUserDayMetrics> dayMetrics

exceptionInfo

List<HistoricalAdherenceExceptionInfo> exceptionInfo

impact

WfmHistoricalAdherenceBulkUserResult.ImpactEnum impact

userId

String userId

Class com.mypurecloud.sdk.v2.model.WfmHistoricalAdherenceCalculationsCompleteTopicWfmHistoricalAdherenceCalculationsCompleteNotice

class WfmHistoricalAdherenceCalculationsCompleteTopicWfmHistoricalAdherenceCalculationsCompleteNotice extends Object implements Serializable

Serialized Fields

downloadUrl

String downloadUrl

downloadUrls

List<String> downloadUrls

id

String id

queryState

WfmHistoricalAdherenceCalculationsCompleteTopicWfmHistoricalAdherenceCalculationsCompleteNotice.QueryStateEnum queryState

Class com.mypurecloud.sdk.v2.model.WfmHistoricalAdherenceQuery

class WfmHistoricalAdherenceQuery extends Object implements Serializable

Serialized Fields

endDate

Date endDate

includeExceptions

Boolean includeExceptions

startDate

Date startDate

teamIds

List<String> teamIds

timeZone

String timeZone

userIds

List<String> userIds

Class com.mypurecloud.sdk.v2.model.WfmHistoricalAdherenceQueryForTeams

class WfmHistoricalAdherenceQueryForTeams extends Object implements Serializable

Serialized Fields

endDate

Date endDate

includeExceptions

Boolean includeExceptions

startDate

Date startDate

timeZone

String timeZone

userIds

List<String> userIds

Class com.mypurecloud.sdk.v2.model.WfmHistoricalAdherenceQueryForUsers

class WfmHistoricalAdherenceQueryForUsers extends Object implements Serializable

Serialized Fields

endDate

Date endDate

includeExceptions

Boolean includeExceptions

startDate

Date startDate

timeZone

String timeZone

userIds

List<String> userIds

Class com.mypurecloud.sdk.v2.model.WfmHistoricalAdherenceResponse

class WfmHistoricalAdherenceResponse extends Object implements Serializable

Serialized Fields

downloadResult

WfmHistoricalAdherenceResultWrapper downloadResult

downloadUrl

String downloadUrl

downloadUrls

List<String> downloadUrls

id

String id

queryState

WfmHistoricalAdherenceResponse.QueryStateEnum queryState

Class com.mypurecloud.sdk.v2.model.WfmHistoricalAdherenceResultWrapper

class WfmHistoricalAdherenceResultWrapper extends Object implements Serializable

Serialized Fields

data

List<HistoricalAdherenceQueryResult> data

entityId

String entityId

lookupIdToSecondaryPresenceId

Map<String,String> lookupIdToSecondaryPresenceId

Class com.mypurecloud.sdk.v2.model.WfmHistoricalDataUploadPurgeRequestStatusTopicHistoricalDataUploadPurgeRequestUpdate

class WfmHistoricalDataUploadPurgeRequestStatusTopicHistoricalDataUploadPurgeRequestUpdate extends Object implements Serializable

Serialized Fields

status

WfmHistoricalDataUploadPurgeRequestStatusTopicHistoricalDataUploadPurgeRequestUpdate.StatusEnum status

Class com.mypurecloud.sdk.v2.model.WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate

class WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate extends Object implements Serializable

Serialized Fields

active

Boolean active

dateCreated

Date dateCreated

dateImportEnded

Date dateImportEnded

dateImportStarted

Date dateImportStarted

dateModified

Date dateModified

error

String error

requestId

String requestId

status

WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate.StatusEnum status

type

WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate.TypeEnum type

Class com.mypurecloud.sdk.v2.model.WfmHistoricalShrinkageCalculationsCompleteTopicHistoricalShrinkageCalculationsCompleteNotification

class WfmHistoricalShrinkageCalculationsCompleteTopicHistoricalShrinkageCalculationsCompleteNotification extends Object implements Serializable

Serialized Fields

downloadUrls

List<String> downloadUrls

operationId

String operationId

state

WfmHistoricalShrinkageCalculationsCompleteTopicHistoricalShrinkageCalculationsCompleteNotification.StateEnum state

Class com.mypurecloud.sdk.v2.model.WfmHistoricalShrinkageRequest

class WfmHistoricalShrinkageRequest extends Object implements Serializable

Serialized Fields

endDate

Date endDate

granularity

WfmHistoricalShrinkageRequest.GranularityEnum granularity

startDate

Date startDate

timeZone

String timeZone

Class com.mypurecloud.sdk.v2.model.WfmHistoricalShrinkageResponse

class WfmHistoricalShrinkageResponse extends Object implements Serializable

Serialized Fields

downloadResult

HistoricalShrinkageResultListing downloadResult

downloadUrls

List<String> downloadUrls

operationId

String operationId

state

WfmHistoricalShrinkageResponse.StateEnum state

Class com.mypurecloud.sdk.v2.model.WfmHistoricalShrinkageTeamsRequest

class WfmHistoricalShrinkageTeamsRequest extends Object implements Serializable

Serialized Fields

endDate

Date endDate

granularity

WfmHistoricalShrinkageTeamsRequest.GranularityEnum granularity

startDate

Date startDate

timeZone

String timeZone

Class com.mypurecloud.sdk.v2.model.WfmIntegrationsHrisTimeOffTypesJobTopicErrorBody

class WfmIntegrationsHrisTimeOffTypesJobTopicErrorBody extends Object implements Serializable

Serialized Fields

code

String code

message

String message

messageParams

Map<String,String> messageParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.WfmIntegrationsHrisTimeOffTypesJobTopicHrisTimeOffType

class WfmIntegrationsHrisTimeOffTypesJobTopicHrisTimeOffType extends Object implements Serializable

Serialized Fields

id

String id

name

String name

secondaryId

String secondaryId

Class com.mypurecloud.sdk.v2.model.WfmIntegrationsHrisTimeOffTypesJobTopicHrisTimeOffTypesJobNotification

class WfmIntegrationsHrisTimeOffTypesJobTopicHrisTimeOffTypesJobNotification extends Object implements Serializable

Serialized Fields

entities

List<WfmIntegrationsHrisTimeOffTypesJobTopicHrisTimeOffType> entities

error

WfmIntegrationsHrisTimeOffTypesJobTopicErrorBody error

id

String id

status

WfmIntegrationsHrisTimeOffTypesJobTopicHrisTimeOffTypesJobNotification.StatusEnum status

Class com.mypurecloud.sdk.v2.model.WfmIntradayDataUpdateTopicIntradayDataGroup

class WfmIntradayDataUpdateTopicIntradayDataGroup extends Object implements Serializable

Serialized Fields

forecastDataPerInterval

List<WfmIntradayDataUpdateTopicIntradayForecastData> forecastDataPerInterval

historicalAgentDataPerInterval

List<WfmIntradayDataUpdateTopicIntradayHistoricalAgentData> historicalAgentDataPerInterval

historicalQueueDataPerInterval

List<WfmIntradayDataUpdateTopicIntradayHistoricalQueueData> historicalQueueDataPerInterval

mediaType

WfmIntradayDataUpdateTopicIntradayDataGroup.MediaTypeEnum mediaType

performancePredictionAgentDataPerInterval

List<WfmIntradayDataUpdateTopicIntradayPerformancePredictionAgentData> performancePredictionAgentDataPerInterval

performancePredictionQueueDataPerInterval

List<WfmIntradayDataUpdateTopicIntradayPerformancePredictionQueueData> performancePredictionQueueDataPerInterval

scheduleDataPerInterval

List<WfmIntradayDataUpdateTopicIntradayScheduleData> scheduleDataPerInterval

Class com.mypurecloud.sdk.v2.model.WfmIntradayDataUpdateTopicIntradayDataUpdate

class WfmIntradayDataUpdateTopicIntradayDataUpdate extends Object implements Serializable

Serialized Fields

endDate

Date endDate

intervalLengthMinutes

Integer intervalLengthMinutes

intradayDataGroupings

List<WfmIntradayDataUpdateTopicIntradayDataGroup> intradayDataGroupings

metrics

List<WfmIntradayDataUpdateTopicIntradayMetric> metrics

numberOfIntervals

Integer numberOfIntervals

queueIds

List<String> queueIds

startDate

Date startDate

Class com.mypurecloud.sdk.v2.model.WfmIntradayDataUpdateTopicIntradayForecastData

class WfmIntradayDataUpdateTopicIntradayForecastData extends Object implements Serializable

Serialized Fields

averageAfterCallWorkSeconds

BigDecimal averageAfterCallWorkSeconds

averageTalkTimeSeconds

BigDecimal averageTalkTimeSeconds

offered

BigDecimal offered

Class com.mypurecloud.sdk.v2.model.WfmIntradayDataUpdateTopicIntradayHistoricalAgentData

class WfmIntradayDataUpdateTopicIntradayHistoricalAgentData extends Object implements Serializable

Serialized Fields

interactingTimeSeconds

BigDecimal interactingTimeSeconds

onQueueTimeSeconds

BigDecimal onQueueTimeSeconds

Class com.mypurecloud.sdk.v2.model.WfmIntradayDataUpdateTopicIntradayHistoricalQueueData

class WfmIntradayDataUpdateTopicIntradayHistoricalQueueData extends Object implements Serializable

Serialized Fields

abandoned

Integer abandoned

answered

Integer answered

averageAfterCallWorkSeconds

BigDecimal averageAfterCallWorkSeconds

averageSpeedOfAnswerSeconds

BigDecimal averageSpeedOfAnswerSeconds

averageTalkTimeSeconds

BigDecimal averageTalkTimeSeconds

completed

Integer completed

offered

Integer offered

serviceLevelPercent

BigDecimal serviceLevelPercent

Class com.mypurecloud.sdk.v2.model.WfmIntradayDataUpdateTopicIntradayMetric

class WfmIntradayDataUpdateTopicIntradayMetric extends Object implements Serializable

Serialized Fields

category

WfmIntradayDataUpdateTopicIntradayMetric.CategoryEnum category

version

String version

Class com.mypurecloud.sdk.v2.model.WfmIntradayDataUpdateTopicIntradayPerformancePredictionAgentData

class WfmIntradayDataUpdateTopicIntradayPerformancePredictionAgentData extends Object implements Serializable

Serialized Fields

interactingTimeSeconds

BigDecimal interactingTimeSeconds

Class com.mypurecloud.sdk.v2.model.WfmIntradayDataUpdateTopicIntradayPerformancePredictionQueueData

class WfmIntradayDataUpdateTopicIntradayPerformancePredictionQueueData extends Object implements Serializable

Serialized Fields

averageSpeedOfAnswerSeconds

BigDecimal averageSpeedOfAnswerSeconds

numberOfInteractions

BigDecimal numberOfInteractions

serviceLevelPercent

BigDecimal serviceLevelPercent

Class com.mypurecloud.sdk.v2.model.WfmIntradayDataUpdateTopicIntradayScheduleData

class WfmIntradayDataUpdateTopicIntradayScheduleData extends Object implements Serializable

Serialized Fields

onQueueTimeSeconds

Integer onQueueTimeSeconds

scheduledTimeSeconds

Integer scheduledTimeSeconds

Class com.mypurecloud.sdk.v2.model.WfmIntradayPlanningGroupListing

class WfmIntradayPlanningGroupListing extends Object implements Serializable

Serialized Fields

entities

List<ForecastPlanningGroupResponse> entities

noDataReason

WfmIntradayPlanningGroupListing.NoDataReasonEnum noDataReason

Class com.mypurecloud.sdk.v2.model.WfmMoveAgentsCompleteTopicManagementUnit

class WfmMoveAgentsCompleteTopicManagementUnit extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmMoveAgentsCompleteTopicUserReference

class WfmMoveAgentsCompleteTopicUserReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmMoveAgentsCompleteTopicWfmMoveAgentData

class WfmMoveAgentsCompleteTopicWfmMoveAgentData extends Object implements Serializable

Serialized Fields

result

WfmMoveAgentsCompleteTopicWfmMoveAgentData.ResultEnum result

user

WfmMoveAgentsCompleteTopicUserReference user

Class com.mypurecloud.sdk.v2.model.WfmMoveAgentsCompleteTopicWfmMoveAgentsComplete

class WfmMoveAgentsCompleteTopicWfmMoveAgentsComplete extends Object implements Serializable

Serialized Fields

destinationManagementUnit

WfmMoveAgentsCompleteTopicManagementUnit destinationManagementUnit

requestingUser

WfmMoveAgentsCompleteTopicUserReference requestingUser

results

List<WfmMoveAgentsCompleteTopicWfmMoveAgentData> results

Class com.mypurecloud.sdk.v2.model.WfmMoveManagementUnitTopicBusinessUnit

class WfmMoveManagementUnitTopicBusinessUnit extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmMoveManagementUnitTopicMoveManagementUnitNotification

class WfmMoveManagementUnitTopicMoveManagementUnitNotification extends Object implements Serializable

Serialized Fields

businessUnit

WfmMoveManagementUnitTopicBusinessUnit businessUnit

status

WfmMoveManagementUnitTopicMoveManagementUnitNotification.StatusEnum status

Class com.mypurecloud.sdk.v2.model.WfmProcessUploadRequest

class WfmProcessUploadRequest extends Object implements Serializable

Serialized Fields

uploadKey

String uploadKey

Class com.mypurecloud.sdk.v2.model.WfmScheduleActivity

class WfmScheduleActivity extends Object implements Serializable

Serialized Fields

activities

List<ScheduleActivity> activities

fullDayTimeOffMarkers

List<FullDayTimeOffMarker> fullDayTimeOffMarkers

userReference

UserReference userReference

Class com.mypurecloud.sdk.v2.model.WfmScheduleReference

class WfmScheduleReference extends Object implements Serializable

Serialized Fields

businessUnit

WfmBusinessUnitReference businessUnit

id

String id

selfUri

String selfUri

weekDate

LocalDate weekDate

Class com.mypurecloud.sdk.v2.model.WfmScheduleTopicWfmScheduleNotification

class WfmScheduleTopicWfmScheduleNotification extends Object implements Serializable

Serialized Fields

downloadUrl

String downloadUrl

eventType

WfmScheduleTopicWfmScheduleNotification.EventTypeEnum eventType

operationId

String operationId

percentComplete

Integer percentComplete

status

WfmScheduleTopicWfmScheduleNotification.StatusEnum status

Class com.mypurecloud.sdk.v2.model.WfmServiceGoalImpact

class WfmServiceGoalImpact extends Object implements Serializable

Serialized Fields

decreaseByPercent

Double decreaseByPercent

increaseByPercent

Double increaseByPercent

Class com.mypurecloud.sdk.v2.model.WfmServiceGoalImpactSettings

class WfmServiceGoalImpactSettings extends Object implements Serializable

Serialized Fields

abandonRate

WfmServiceGoalImpact abandonRate

averageSpeedOfAnswer

WfmServiceGoalImpact averageSpeedOfAnswer

serviceLevel

WfmServiceGoalImpact serviceLevel

Class com.mypurecloud.sdk.v2.model.WfmTimeOffBalanceJobTopicErrorBody

class WfmTimeOffBalanceJobTopicErrorBody extends Object implements Serializable

Serialized Fields

code

String code

message

String message

messageParams

Map<String,String> messageParams

status

Integer status

Class com.mypurecloud.sdk.v2.model.WfmTimeOffBalanceJobTopicTimeOffBalance

class WfmTimeOffBalanceJobTopicTimeOffBalance extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

balanceMinutesPerDay

List<Integer> balanceMinutesPerDay

hrisTimeOffTypeId

String hrisTimeOffTypeId

hrisTimeOffTypeSecondaryId

String hrisTimeOffTypeSecondaryId

startDate

Date startDate

Class com.mypurecloud.sdk.v2.model.WfmTimeOffBalanceJobTopicTimeOffBalanceJobNotification

class WfmTimeOffBalanceJobTopicTimeOffBalanceJobNotification extends Object implements Serializable

Serialized Fields

entities

List<WfmTimeOffBalanceJobTopicTimeOffBalance> entities

error

WfmTimeOffBalanceJobTopicErrorBody error

id

String id

status

WfmTimeOffBalanceJobTopicTimeOffBalanceJobNotification.StatusEnum status

Class com.mypurecloud.sdk.v2.model.WfmTimeOffRequestUpdateTopicTimeOffRequestUpdate

class WfmTimeOffRequestUpdateTopicTimeOffRequestUpdate extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

dailyDurationMinutes

Integer dailyDurationMinutes

fullDayManagementUnitDates

List<String> fullDayManagementUnitDates

id

String id

isFullDayRequest

Boolean isFullDayRequest

markedAsRead

Boolean markedAsRead

modifiedBy

String modifiedBy

modifiedDate

String modifiedDate

notes

String notes

paid

Boolean paid

partialDayStartDateTimes

List<String> partialDayStartDateTimes

reviewedBy

String reviewedBy

reviewedDate

String reviewedDate

status

WfmTimeOffRequestUpdateTopicTimeOffRequestUpdate.StatusEnum status

submittedBy

String submittedBy

submittedDate

String submittedDate

substatus

WfmTimeOffRequestUpdateTopicTimeOffRequestUpdate.SubstatusEnum substatus

user

WfmTimeOffRequestUpdateTopicUserReference user

Class com.mypurecloud.sdk.v2.model.WfmTimeOffRequestUpdateTopicUserReference

class WfmTimeOffRequestUpdateTopicUserReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmUpdateAgentDetailsTopicWfmUpdateAgentDetailsComplete

class WfmUpdateAgentDetailsTopicWfmUpdateAgentDetailsComplete extends Object implements Serializable

Serialized Fields

status

WfmUpdateAgentDetailsTopicWfmUpdateAgentDetailsComplete.StatusEnum status

Class com.mypurecloud.sdk.v2.model.WfmUserEntityListing

class WfmUserEntityListing extends Object implements Serializable

Serialized Fields

entities

List<User> entities

Class com.mypurecloud.sdk.v2.model.WfmUserNotification

class WfmUserNotification extends Object implements Serializable

Serialized Fields

adherenceExplanation

AdherenceExplanationNotification adherenceExplanation

agentNotification

Boolean agentNotification

id

String id

markedAsRead

Boolean markedAsRead

mutableGroupId

String mutableGroupId

otherNotificationIdsInGroup

List<String> otherNotificationIdsInGroup

shiftTrade

ShiftTradeNotification shiftTrade

timeOffRequest

TimeOffRequestNotification timeOffRequest

timestamp

Date timestamp

type

WfmUserNotification.TypeEnum type

Class com.mypurecloud.sdk.v2.model.WfmUserNotificationTopicAdherenceExplanationNotification

class WfmUserNotificationTopicAdherenceExplanationNotification extends Object implements Serializable

Serialized Fields

agent

WfmUserNotificationTopicUserReference agent

businessUnit

WfmUserNotificationTopicBusinessUnit businessUnit

id

String id

lengthMinutes

Integer lengthMinutes

managementUnit

WfmUserNotificationTopicManagementUnit managementUnit

notes

String notes

startDate

Date startDate

status

WfmUserNotificationTopicAdherenceExplanationNotification.StatusEnum status

type

WfmUserNotificationTopicAdherenceExplanationNotification.TypeEnum type

Class com.mypurecloud.sdk.v2.model.WfmUserNotificationTopicBusinessUnit

class WfmUserNotificationTopicBusinessUnit extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmUserNotificationTopicManagementUnit

class WfmUserNotificationTopicManagementUnit extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmUserNotificationTopicShiftTradeNotification

class WfmUserNotificationTopicShiftTradeNotification extends Object implements Serializable

Serialized Fields

initiatingShiftDate

Date initiatingShiftDate

initiatingUser

WfmUserNotificationTopicUserReference initiatingUser

newState

WfmUserNotificationTopicShiftTradeNotification.NewStateEnum newState

oneSided

Boolean oneSided

receivingShiftDate

Date receivingShiftDate

receivingUser

WfmUserNotificationTopicUserReference receivingUser

tradeId

String tradeId

weekDate

String weekDate

Class com.mypurecloud.sdk.v2.model.WfmUserNotificationTopicTimeOffRequestNotification

class WfmUserNotificationTopicTimeOffRequestNotification extends Object implements Serializable

Serialized Fields

fullDayManagementUnitDates

List<String> fullDayManagementUnitDates

isFullDayRequest

Boolean isFullDayRequest

partialDayStartDateTimes

List<Date> partialDayStartDateTimes

status

WfmUserNotificationTopicTimeOffRequestNotification.StatusEnum status

timeOffRequestId

String timeOffRequestId

user

WfmUserNotificationTopicUserReference user

Class com.mypurecloud.sdk.v2.model.WfmUserNotificationTopicUserReference

class WfmUserNotificationTopicUserReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmUserNotificationTopicWfmUserNotification

class WfmUserNotificationTopicWfmUserNotification extends Object implements Serializable

Serialized Fields

adherenceExplanation

WfmUserNotificationTopicAdherenceExplanationNotification adherenceExplanation

agentNotification

Boolean agentNotification

id

String id

markedAsRead

Boolean markedAsRead

mutableGroupId

String mutableGroupId

otherNotificationIdsInGroup

List<String> otherNotificationIdsInGroup

shiftTrade

WfmUserNotificationTopicShiftTradeNotification shiftTrade

timeOffRequest

WfmUserNotificationTopicTimeOffRequestNotification timeOffRequest

timestamp

Date timestamp

type

WfmUserNotificationTopicWfmUserNotification.TypeEnum type

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedMuTopicActivityCodeReference

class WfmUserScheduleAdherenceUpdatedMuTopicActivityCodeReference extends Object implements Serializable

Serialized Fields

id

String id

secondaryPresences

List<WfmUserScheduleAdherenceUpdatedMuTopicSecondaryPresenceReference> secondaryPresences

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedMuTopicQueueReference

class WfmUserScheduleAdherenceUpdatedMuTopicQueueReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedMuTopicRealTimeAdherenceExplanation

class WfmUserScheduleAdherenceUpdatedMuTopicRealTimeAdherenceExplanation extends Object implements Serializable

Serialized Fields

id

String id

lengthMinutes

Integer lengthMinutes

startDate

Date startDate

status

WfmUserScheduleAdherenceUpdatedMuTopicRealTimeAdherenceExplanation.StatusEnum status

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedMuTopicSecondaryPresenceReference

class WfmUserScheduleAdherenceUpdatedMuTopicSecondaryPresenceReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedMuTopicUriReference

class WfmUserScheduleAdherenceUpdatedMuTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedMuTopicUserReference

class WfmUserScheduleAdherenceUpdatedMuTopicUserReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedMuTopicUserScheduleAdherenceUpdate

class WfmUserScheduleAdherenceUpdatedMuTopicUserScheduleAdherenceUpdate extends Object implements Serializable

Serialized Fields

activeQueues

List<WfmUserScheduleAdherenceUpdatedMuTopicQueueReference> activeQueues

activeQueuesModifiedTime

Date activeQueuesModifiedTime

actualActivityCategory

String actualActivityCategory

adherenceChangeTime

Date adherenceChangeTime

adherenceExplanation

WfmUserScheduleAdherenceUpdatedMuTopicRealTimeAdherenceExplanation adherenceExplanation

adherenceState

WfmUserScheduleAdherenceUpdatedMuTopicUserScheduleAdherenceUpdate.AdherenceStateEnum adherenceState

impact

String impact

isOutOfOffice

Boolean isOutOfOffice

managementUnitId

String managementUnitId

organizationSecondaryPresenceId

String organizationSecondaryPresenceId

presenceUpdateTime

Date presenceUpdateTime

removedFromManagementUnit

Boolean removedFromManagementUnit

routingStatus

WfmUserScheduleAdherenceUpdatedMuTopicUserScheduleAdherenceUpdate.RoutingStatusEnum routingStatus

scheduledActivityCategory

String scheduledActivityCategory

scheduledActivityCode

WfmUserScheduleAdherenceUpdatedMuTopicActivityCodeReference scheduledActivityCode

systemPresence

String systemPresence

team

WfmUserScheduleAdherenceUpdatedMuTopicUriReference team

user

WfmUserScheduleAdherenceUpdatedMuTopicUserReference user

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedTeamTopicActivityCodeReference

class WfmUserScheduleAdherenceUpdatedTeamTopicActivityCodeReference extends Object implements Serializable

Serialized Fields

id

String id

secondaryPresences

List<WfmUserScheduleAdherenceUpdatedTeamTopicSecondaryPresenceReference> secondaryPresences

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedTeamTopicQueueReference

class WfmUserScheduleAdherenceUpdatedTeamTopicQueueReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedTeamTopicRealTimeAdherenceExplanation

class WfmUserScheduleAdherenceUpdatedTeamTopicRealTimeAdherenceExplanation extends Object implements Serializable

Serialized Fields

id

String id

lengthMinutes

Integer lengthMinutes

startDate

Date startDate

status

WfmUserScheduleAdherenceUpdatedTeamTopicRealTimeAdherenceExplanation.StatusEnum status

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedTeamTopicSecondaryPresenceReference

class WfmUserScheduleAdherenceUpdatedTeamTopicSecondaryPresenceReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedTeamTopicUriReference

class WfmUserScheduleAdherenceUpdatedTeamTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedTeamTopicUserReference

class WfmUserScheduleAdherenceUpdatedTeamTopicUserReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedTeamTopicUserScheduleAdherenceUpdate

class WfmUserScheduleAdherenceUpdatedTeamTopicUserScheduleAdherenceUpdate extends Object implements Serializable

Serialized Fields

activeQueues

List<WfmUserScheduleAdherenceUpdatedTeamTopicQueueReference> activeQueues

activeQueuesModifiedTime

Date activeQueuesModifiedTime

actualActivityCategory

String actualActivityCategory

adherenceChangeTime

Date adherenceChangeTime

adherenceExplanation

WfmUserScheduleAdherenceUpdatedTeamTopicRealTimeAdherenceExplanation adherenceExplanation

adherenceState

WfmUserScheduleAdherenceUpdatedTeamTopicUserScheduleAdherenceUpdate.AdherenceStateEnum adherenceState

impact

String impact

isOutOfOffice

Boolean isOutOfOffice

managementUnitId

String managementUnitId

organizationSecondaryPresenceId

String organizationSecondaryPresenceId

presenceUpdateTime

Date presenceUpdateTime

removedFromManagementUnit

Boolean removedFromManagementUnit

routingStatus

WfmUserScheduleAdherenceUpdatedTeamTopicUserScheduleAdherenceUpdate.RoutingStatusEnum routingStatus

scheduledActivityCategory

String scheduledActivityCategory

scheduledActivityCode

WfmUserScheduleAdherenceUpdatedTeamTopicActivityCodeReference scheduledActivityCode

systemPresence

String systemPresence

team

WfmUserScheduleAdherenceUpdatedTeamTopicUriReference team

user

WfmUserScheduleAdherenceUpdatedTeamTopicUserReference user

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedTopicActivityCodeReference

class WfmUserScheduleAdherenceUpdatedTopicActivityCodeReference extends Object implements Serializable

Serialized Fields

id

String id

secondaryPresences

List<WfmUserScheduleAdherenceUpdatedTopicSecondaryPresenceReference> secondaryPresences

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedTopicQueueReference

class WfmUserScheduleAdherenceUpdatedTopicQueueReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedTopicRealTimeAdherenceExplanation

class WfmUserScheduleAdherenceUpdatedTopicRealTimeAdherenceExplanation extends Object implements Serializable

Serialized Fields

id

String id

lengthMinutes

Integer lengthMinutes

startDate

Date startDate

status

WfmUserScheduleAdherenceUpdatedTopicRealTimeAdherenceExplanation.StatusEnum status

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedTopicSecondaryPresenceReference

class WfmUserScheduleAdherenceUpdatedTopicSecondaryPresenceReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedTopicUriReference

class WfmUserScheduleAdherenceUpdatedTopicUriReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedTopicUserReference

class WfmUserScheduleAdherenceUpdatedTopicUserReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WfmUserScheduleAdherenceUpdatedTopicUserScheduleAdherenceUpdate

class WfmUserScheduleAdherenceUpdatedTopicUserScheduleAdherenceUpdate extends Object implements Serializable

Serialized Fields

activeQueues

List<WfmUserScheduleAdherenceUpdatedTopicQueueReference> activeQueues

activeQueuesModifiedTime

Date activeQueuesModifiedTime

actualActivityCategory

String actualActivityCategory

adherenceChangeTime

Date adherenceChangeTime

adherenceExplanation

WfmUserScheduleAdherenceUpdatedTopicRealTimeAdherenceExplanation adherenceExplanation

adherenceState

WfmUserScheduleAdherenceUpdatedTopicUserScheduleAdherenceUpdate.AdherenceStateEnum adherenceState

impact

String impact

isOutOfOffice

Boolean isOutOfOffice

managementUnitId

String managementUnitId

organizationSecondaryPresenceId

String organizationSecondaryPresenceId

presenceUpdateTime

Date presenceUpdateTime

removedFromManagementUnit

Boolean removedFromManagementUnit

routingStatus

WfmUserScheduleAdherenceUpdatedTopicUserScheduleAdherenceUpdate.RoutingStatusEnum routingStatus

scheduledActivityCategory

String scheduledActivityCategory

scheduledActivityCode

WfmUserScheduleAdherenceUpdatedTopicActivityCodeReference scheduledActivityCode

systemPresence

String systemPresence

team

WfmUserScheduleAdherenceUpdatedTopicUriReference team

user

WfmUserScheduleAdherenceUpdatedTopicUserReference user

Class com.mypurecloud.sdk.v2.model.WfmVersionedEntityMetadata

class WfmVersionedEntityMetadata extends Object implements Serializable

Serialized Fields

createdBy

UserReference createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

modifiedBy

UserReference modifiedBy

version

Integer version

Class com.mypurecloud.sdk.v2.model.WhatsAppAvailablePhoneNumberDetails

class WhatsAppAvailablePhoneNumberDetails extends Object implements Serializable

Serialized Fields

name

String name

phoneNumber

String phoneNumber

status

String status

Class com.mypurecloud.sdk.v2.model.WhatsAppAvailablePhoneNumberDetailsListing

class WhatsAppAvailablePhoneNumberDetailsListing extends Object implements Serializable

Serialized Fields

entities

List<WhatsAppAvailablePhoneNumberDetails> entities

Class com.mypurecloud.sdk.v2.model.WhatsAppDefinition

class WhatsAppDefinition extends Object implements Serializable

Serialized Fields

language

String language

name

String name

namespace

String namespace

Class com.mypurecloud.sdk.v2.model.WhatsAppId

class WhatsAppId extends Object implements Serializable

Serialized Fields

displayName

String displayName

phoneNumber

PhoneNumber phoneNumber

Class com.mypurecloud.sdk.v2.model.WhatsAppIntegration

class WhatsAppIntegration extends Object implements Serializable

Serialized Fields

activationErrorInfo

ErrorBody activationErrorInfo

activationStatusCode

WhatsAppIntegration.ActivationStatusCodeEnum activationStatusCode

availablePhoneNumbers

WhatsAppAvailablePhoneNumberDetailsListing availablePhoneNumbers

createdBy

DomainEntityRef createdBy

createError

ErrorBody createError

createStatus

WhatsAppIntegration.CreateStatusEnum createStatus

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

messagingSetting

MessagingSettingReference messagingSetting

modifiedBy

DomainEntityRef modifiedBy

name

String name

phoneNumber

String phoneNumber

recipient

DomainEntityRef recipient

selfUri

String selfUri

status

WhatsAppIntegration.StatusEnum status

supportedContent

SupportedContentReference supportedContent

version

Integer version

Class com.mypurecloud.sdk.v2.model.WhatsAppIntegrationEntityListing

class WhatsAppIntegrationEntityListing extends Object implements Serializable

Serialized Fields

entities

List<WhatsAppIntegration> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.WhatsAppIntegrationRequest

class WhatsAppIntegrationRequest extends Object implements Serializable

Serialized Fields

id

String id

messagingSetting

MessagingSettingRequestReference messagingSetting

name

String name

phoneNumber

String phoneNumber

selfUri

String selfUri

supportedContent

SupportedContentReference supportedContent

wabaCertificate

String wabaCertificate

Class com.mypurecloud.sdk.v2.model.WhatsAppIntegrationUpdateRequest

class WhatsAppIntegrationUpdateRequest extends Object implements Serializable

Serialized Fields

action

WhatsAppIntegrationUpdateRequest.ActionEnum action

authenticationMethod

WhatsAppIntegrationUpdateRequest.AuthenticationMethodEnum authenticationMethod

confirmationCode

String confirmationCode

id

String id

messagingSetting

MessagingSettingRequestReference messagingSetting

name

String name

phoneNumber

String phoneNumber

selfUri

String selfUri

supportedContent

SupportedContentReference supportedContent

Class com.mypurecloud.sdk.v2.model.WidgetClientConfig

class WidgetClientConfig extends Object implements Serializable

Serialized Fields

thirdParty

Object thirdParty

v1

WidgetClientConfigV1 v1

v1Http

WidgetClientConfigV1Http v1Http

v2

Object v2

Class com.mypurecloud.sdk.v2.model.WidgetClientConfigThirdParty

class WidgetClientConfigThirdParty extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.WidgetClientConfigV1

class WidgetClientConfigV1 extends Object implements Serializable

Serialized Fields

authenticationUrl

String authenticationUrl

webChatSkin

WidgetClientConfigV1.WebChatSkinEnum webChatSkin

Class com.mypurecloud.sdk.v2.model.WidgetClientConfigV1Http

class WidgetClientConfigV1Http extends Object implements Serializable

Serialized Fields

authenticationUrl

String authenticationUrl

webChatSkin

WidgetClientConfigV1Http.WebChatSkinEnum webChatSkin

Class com.mypurecloud.sdk.v2.model.WidgetClientConfigV2

class WidgetClientConfigV2 extends Object implements Serializable

Class com.mypurecloud.sdk.v2.model.WidgetDeployment

class WidgetDeployment extends Object implements Serializable

Serialized Fields

allowedDomains

List<String> allowedDomains

authenticationRequired

Boolean authenticationRequired

clientConfig

WidgetClientConfig clientConfig

clientType

WidgetDeployment.ClientTypeEnum clientType

description

String description

disabled

Boolean disabled

flow

DomainEntityRef flow

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WidgetDeploymentEntityListing

class WidgetDeploymentEntityListing extends Object implements Serializable

Serialized Fields

entities

List<WidgetDeployment> entities

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.Workbin

class Workbin extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

id

String id

modifiedBy

UserReference modifiedBy

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WorkbinChangeListing

class WorkbinChangeListing extends Object implements Serializable

Serialized Fields

after

String after

entities

List<WorkitemsChangeWorkbinDelta> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WorkbinCreate

class WorkbinCreate extends Object implements Serializable

Serialized Fields

description

String description

divisionId

String divisionId

name

String name

Class com.mypurecloud.sdk.v2.model.WorkbinDelta

class WorkbinDelta extends Object implements Serializable

Serialized Fields

dateModified

WorkitemsAttributeChangeInstant dateModified

description

WorkitemsAttributeChangeString description

modifiedBy

WorkitemsAttributeChangeString modifiedBy

name

WorkitemsAttributeChangeString name

Class com.mypurecloud.sdk.v2.model.WorkbinQueryEntityListing

class WorkbinQueryEntityListing extends Object implements Serializable

Serialized Fields

after

String after

count

Integer count

entities

List<Workbin> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WorkbinQueryRequest

class WorkbinQueryRequest extends Object implements Serializable

Serialized Fields

after

String after

attributes

List<String> attributes

filters

List<WorkitemFilter> filters

pageSize

Integer pageSize

select

WorkbinQueryRequest.SelectEnum select

sort

WorkbinQuerySort sort

Class com.mypurecloud.sdk.v2.model.WorkbinQuerySort

class WorkbinQuerySort extends Object implements Serializable

Serialized Fields

ascending

Boolean ascending

name

WorkbinQuerySort.NameEnum name

Class com.mypurecloud.sdk.v2.model.WorkbinReference

class WorkbinReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WorkbinUpdate

class WorkbinUpdate extends Object implements Serializable

Serialized Fields

description

String description

name

String name

Class com.mypurecloud.sdk.v2.model.WorkbinVersion

class WorkbinVersion extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

division

Division division

id

String id

modifiedBy

UserReference modifiedBy

name

String name

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.WorkbinVersionListing

class WorkbinVersionListing extends Object implements Serializable

Serialized Fields

after

String after

entities

List<WorkbinVersion> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WorkdayMetric

class WorkdayMetric extends Object implements Serializable

Serialized Fields

maxPoints

Integer maxPoints

metric

Metric metric

objective

Objective objective

points

Integer points

punctualityEvents

List<PunctualityEvent> punctualityEvents

value

Double value

Class com.mypurecloud.sdk.v2.model.WorkdayMetricListing

class WorkdayMetricListing extends Object implements Serializable

Serialized Fields

entities

List<WorkdayMetric> entities

Class com.mypurecloud.sdk.v2.model.WorkdayPeriod

class WorkdayPeriod extends Object implements Serializable

Serialized Fields

dateEndWorkday

LocalDate dateEndWorkday

dateStartWorkday

LocalDate dateStartWorkday

Class com.mypurecloud.sdk.v2.model.WorkdayPointsTrend

class WorkdayPointsTrend extends Object implements Serializable

Serialized Fields

averagePoints

Double averagePoints

dateEndWorkday

LocalDate dateEndWorkday

dateStartWorkday

LocalDate dateStartWorkday

dayOfWeek

WorkdayPointsTrend.DayOfWeekEnum dayOfWeek

trend

List<WorkdayPointsTrendItem> trend

user

UserReference user

Class com.mypurecloud.sdk.v2.model.WorkdayPointsTrendItem

class WorkdayPointsTrendItem extends Object implements Serializable

Serialized Fields

dateWorkday

LocalDate dateWorkday

points

Double points

Class com.mypurecloud.sdk.v2.model.WorkdayValuesMetricItem

class WorkdayValuesMetricItem extends Object implements Serializable

Serialized Fields

average

Double average

metric

AddressableEntityRef metric

metricDefinition

DomainEntityRef metricDefinition

trend

List<WorkdayValuesTrendItem> trend

unitType

WorkdayValuesMetricItem.UnitTypeEnum unitType

Class com.mypurecloud.sdk.v2.model.WorkdayValuesTrend

class WorkdayValuesTrend extends Object implements Serializable

Serialized Fields

dateEndWorkday

LocalDate dateEndWorkday

dateReferenceWorkday

LocalDate dateReferenceWorkday

dateStartWorkday

LocalDate dateStartWorkday

division

Division division

metric

AddressableEntityRef metric

performanceProfile

AddressableEntityRef performanceProfile

results

List<WorkdayValuesMetricItem> results

timezone

String timezone

user

UserReference user

Class com.mypurecloud.sdk.v2.model.WorkdayValuesTrendItem

class WorkdayValuesTrendItem extends Object implements Serializable

Serialized Fields

dateWorkday

LocalDate dateWorkday

value

Double value

Class com.mypurecloud.sdk.v2.model.WorkflowTargetSettings

class WorkflowTargetSettings extends Object implements Serializable

Serialized Fields

dataFormat

WorkflowTargetSettings.DataFormatEnum dataFormat

Class com.mypurecloud.sdk.v2.model.Workitem

class Workitem extends Object implements Serializable

Serialized Fields

alertTimeoutSeconds

Integer alertTimeoutSeconds

assignee

UserReferenceWithName assignee

assignmentState

Workitem.AssignmentStateEnum assignmentState

autoStatusTransition

Boolean autoStatusTransition

autoStatusTransitionDetail

AutoStatusTransitionDetail autoStatusTransitionDetail

customFields

Map<String,Object> customFields

dateAssignmentStateChanged

Date dateAssignmentStateChanged

dateClosed

Date dateClosed

dateCreated

Date dateCreated

dateDue

Date dateDue

dateExpires

Date dateExpires

dateModified

Date dateModified

dateStatusChanged

Date dateStatusChanged

description

String description

division

Division division

durationSeconds

Integer durationSeconds

externalContact

ExternalContactReference externalContact

externalTag

String externalTag

id

String id

language

LanguageReference language

modifiedBy

UserReference modifiedBy

name

String name

preferredAgents

List<UserReference> preferredAgents

priority

Integer priority

queue

QueueReference queue

reporter

UserReferenceWithName reporter

schema

WorkitemSchema schema

scoredAgents

List<WorkitemScoredAgent> scoredAgents

selfUri

String selfUri

skills

List<RoutingSkillReference> skills

status

WorkitemStatusReference status

statusCategory

Workitem.StatusCategoryEnum statusCategory

ttl

Integer ttl

type

WorktypeReference type

workbin

WorkbinReference workbin

Class com.mypurecloud.sdk.v2.model.WorkitemChangeListing

class WorkitemChangeListing extends Object implements Serializable

Serialized Fields

after

String after

entities

List<WorkitemsChangeWorkitemDelta> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WorkitemCreate

class WorkitemCreate extends Object implements Serializable

Serialized Fields

assigneeId

String assigneeId

autoStatusTransition

Boolean autoStatusTransition

customFields

Map<String,Object> customFields

dateDue

Date dateDue

dateExpires

Date dateExpires

description

String description

durationSeconds

Integer durationSeconds

externalContactId

String externalContactId

externalTag

String externalTag

languageId

String languageId

name

String name

preferredAgentIds

List<String> preferredAgentIds

priority

Integer priority

queueId

String queueId

scoredAgents

List<WorkitemScoredAgentRequest> scoredAgents

skillIds

List<String> skillIds

statusId

String statusId

ttl

Integer ttl

typeId

String typeId

workbinId

String workbinId

wrapupCode

String wrapupCode

Class com.mypurecloud.sdk.v2.model.WorkitemDelta

class WorkitemDelta extends Object implements Serializable

Serialized Fields

assigneeId

WorkitemsAttributeChangeString assigneeId

assignmentState

WorkitemsAttributeChangeString assignmentState

autoStatusTransition

WorkitemsAttributeChangeBoolean autoStatusTransition

customFields

WorkitemsAttributeChangeMap customFields

dateClosed

WorkitemsAttributeChangeInstant dateClosed

dateDue

WorkitemsAttributeChangeInstant dateDue

dateExpires

WorkitemsAttributeChangeInstant dateExpires

dateModified

WorkitemsAttributeChangeInstant dateModified

description

WorkitemsAttributeChangeString description

durationSeconds

WorkitemsAttributeChangeInteger durationSeconds

externalContactId

WorkitemsAttributeChangeString externalContactId

externalTag

WorkitemsAttributeChangeString externalTag

languageId

WorkitemsAttributeChangeString languageId

modifiedBy

WorkitemsAttributeChangeString modifiedBy

name

WorkitemsAttributeChangeString name

preferredAgentIds

WorkitemsAttributeChangeList preferredAgentIds

priority

WorkitemsAttributeChangeInteger priority

queueId

WorkitemsAttributeChangeString queueId

reporterId

WorkitemsAttributeChangeString reporterId

skillIds

WorkitemsAttributeChangeList skillIds

statusCategory

WorkitemsAttributeChangeWorkitemStatusCategory statusCategory

statusId

WorkitemsAttributeChangeString statusId

ttl

WorkitemsAttributeChangeInteger ttl

workbinId

WorkitemsAttributeChangeString workbinId

wrapupId

WorkitemsAttributeChangeString wrapupId

Class com.mypurecloud.sdk.v2.model.WorkitemFilter

class WorkitemFilter extends Object implements Serializable

Serialized Fields

name

String name

operator

WorkitemFilter.OperatorEnum operator

type

WorkitemFilter.TypeEnum type

values

List<String> values

Class com.mypurecloud.sdk.v2.model.WorkitemManualAssign

class WorkitemManualAssign extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WorkitemPostQueryEntityListing

class WorkitemPostQueryEntityListing extends Object implements Serializable

Serialized Fields

after

String after

count

Integer count

entities

List<Workitem> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WorkitemQueryPostRequest

class WorkitemQueryPostRequest extends Object implements Serializable

Serialized Fields

after

String after

attributes

List<String> attributes

expands

List<WorkitemQueryPostRequest.ExpandsEnum> expands

filters

List<WorkitemFilter> filters

pageSize

Integer pageSize

select

WorkitemQueryPostRequest.SelectEnum select

sort

WorkitemQuerySort sort

Class com.mypurecloud.sdk.v2.model.WorkitemQuerySort

class WorkitemQuerySort extends Object implements Serializable

Serialized Fields

ascending

Boolean ascending

name

WorkitemQuerySort.NameEnum name

Class com.mypurecloud.sdk.v2.model.WorkitemReference

class WorkitemReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WorkitemsAttributeChangeBoolean

class WorkitemsAttributeChangeBoolean extends Object implements Serializable

Serialized Fields

newValue

Boolean newValue

oldValue

Boolean oldValue

Class com.mypurecloud.sdk.v2.model.WorkitemsAttributeChangeInstant

class WorkitemsAttributeChangeInstant extends Object implements Serializable

Serialized Fields

newValue

Date newValue

oldValue

Date oldValue

Class com.mypurecloud.sdk.v2.model.WorkitemsAttributeChangeInteger

class WorkitemsAttributeChangeInteger extends Object implements Serializable

Serialized Fields

newValue

Integer newValue

oldValue

Integer oldValue

Class com.mypurecloud.sdk.v2.model.WorkitemsAttributeChangeList

class WorkitemsAttributeChangeList extends Object implements Serializable

Serialized Fields

newValue

List<Object> newValue

oldValue

List<Object> oldValue

Class com.mypurecloud.sdk.v2.model.WorkitemsAttributeChangeMap

class WorkitemsAttributeChangeMap extends Object implements Serializable

Serialized Fields

newValue

Map<String,Object> newValue

oldValue

Map<String,Object> oldValue

Class com.mypurecloud.sdk.v2.model.WorkitemsAttributeChangeString

class WorkitemsAttributeChangeString extends Object implements Serializable

Serialized Fields

newValue

String newValue

oldValue

String oldValue

Class com.mypurecloud.sdk.v2.model.WorkitemsAttributeChangeWorkitemStatusCategory

class WorkitemsAttributeChangeWorkitemStatusCategory extends Object implements Serializable

Serialized Fields

newValue

WorkitemsAttributeChangeWorkitemStatusCategory.NewValueEnum newValue

oldValue

WorkitemsAttributeChangeWorkitemStatusCategory.OldValueEnum oldValue

Class com.mypurecloud.sdk.v2.model.WorkitemsChangeWorkbinDelta

class WorkitemsChangeWorkbinDelta extends Object implements Serializable

Serialized Fields

delta

WorkbinDelta delta

modifiedBy

UserReference modifiedBy

version

Integer version

Class com.mypurecloud.sdk.v2.model.WorkitemsChangeWorkitemDelta

class WorkitemsChangeWorkitemDelta extends Object implements Serializable

Serialized Fields

delta

WorkitemDelta delta

modifiedBy

UserReference modifiedBy

version

Integer version

Class com.mypurecloud.sdk.v2.model.WorkitemsChangeWorktypeDelta

class WorkitemsChangeWorktypeDelta extends Object implements Serializable

Serialized Fields

delta

WorktypeDelta delta

modifiedBy

UserReference modifiedBy

version

Integer version

Class com.mypurecloud.sdk.v2.model.WorkitemSchema

class WorkitemSchema extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.WorkitemScoredAgent

class WorkitemScoredAgent extends Object implements Serializable

Serialized Fields

agent

UserReference agent

score

Integer score

Class com.mypurecloud.sdk.v2.model.WorkitemScoredAgentRequest

class WorkitemScoredAgentRequest extends Object implements Serializable

Serialized Fields

id

String id

score

Integer score

Class com.mypurecloud.sdk.v2.model.WorkitemsEventsNotificationCustomAttribute

class WorkitemsEventsNotificationCustomAttribute extends Object implements Serializable

Serialized Fields

dataType

WorkitemsEventsNotificationCustomAttribute.DataTypeEnum dataType

value

String value

Class com.mypurecloud.sdk.v2.model.WorkitemsEventsNotificationDelta

class WorkitemsEventsNotificationDelta extends Object implements Serializable

Serialized Fields

field

String field

newValue

String newValue

oldValue

String oldValue

op

WorkitemsEventsNotificationDelta.OpEnum op

Class com.mypurecloud.sdk.v2.model.WorkitemsEventsNotificationWorkitem

class WorkitemsEventsNotificationWorkitem extends Object implements Serializable

Serialized Fields

alertTimeoutSeconds

Integer alertTimeoutSeconds

assigneeId

String assigneeId

assignmentId

String assignmentId

assignmentState

WorkitemsEventsNotificationWorkitem.AssignmentStateEnum assignmentState

changes

List<WorkitemsEventsNotificationDelta> changes

customFields

Map<String,WorkitemsEventsNotificationCustomAttribute> customFields

dateAssignmentStateChanged

String dateAssignmentStateChanged

dateClosed

String dateClosed

dateCreated

String dateCreated

dateDue

String dateDue

dateExpires

String dateExpires

dateModified

String dateModified

description

String description

durationSeconds

Integer durationSeconds

externalContactId

String externalContactId

externalTag

String externalTag

id

String id

languageId

String languageId

modifiedBy

String modifiedBy

name

String name

operation

WorkitemsEventsNotificationWorkitem.OperationEnum operation

priority

Integer priority

queueId

String queueId

reporterId

String reporterId

statusCategory

WorkitemsEventsNotificationWorkitem.StatusCategoryEnum statusCategory

statusId

String statusId

ttl

Integer ttl

typeId

String typeId

workbinId

String workbinId

wrapup

WorkitemsEventsNotificationWrapup wrapup

wrapupId

String wrapupId

Class com.mypurecloud.sdk.v2.model.WorkitemsEventsNotificationWrapup

class WorkitemsEventsNotificationWrapup extends Object implements Serializable

Serialized Fields

action

WorkitemsEventsNotificationWrapup.ActionEnum action

code

String code

op

WorkitemsEventsNotificationWrapup.OpEnum op

userId

String userId

Class com.mypurecloud.sdk.v2.model.WorkitemsQueueEventsNotificationCustomAttribute

class WorkitemsQueueEventsNotificationCustomAttribute extends Object implements Serializable

Serialized Fields

dataType

WorkitemsQueueEventsNotificationCustomAttribute.DataTypeEnum dataType

value

String value

Class com.mypurecloud.sdk.v2.model.WorkitemsQueueEventsNotificationDelta

class WorkitemsQueueEventsNotificationDelta extends Object implements Serializable

Serialized Fields

field

String field

newValue

String newValue

oldValue

String oldValue

op

WorkitemsQueueEventsNotificationDelta.OpEnum op

Class com.mypurecloud.sdk.v2.model.WorkitemsQueueEventsNotificationWorkitem

class WorkitemsQueueEventsNotificationWorkitem extends Object implements Serializable

Serialized Fields

alertTimeoutSeconds

Integer alertTimeoutSeconds

assigneeId

String assigneeId

assignmentId

String assignmentId

assignmentState

WorkitemsQueueEventsNotificationWorkitem.AssignmentStateEnum assignmentState

changes

List<WorkitemsQueueEventsNotificationDelta> changes

customFields

Map<String,WorkitemsQueueEventsNotificationCustomAttribute> customFields

dateAssignmentStateChanged

String dateAssignmentStateChanged

dateClosed

String dateClosed

dateCreated

String dateCreated

dateDue

String dateDue

dateExpires

String dateExpires

dateModified

String dateModified

description

String description

durationSeconds

Integer durationSeconds

externalContactId

String externalContactId

externalTag

String externalTag

id

String id

languageId

String languageId

modifiedBy

String modifiedBy

name

String name

operation

WorkitemsQueueEventsNotificationWorkitem.OperationEnum operation

priority

Integer priority

queueId

String queueId

reporterId

String reporterId

statusCategory

WorkitemsQueueEventsNotificationWorkitem.StatusCategoryEnum statusCategory

statusId

String statusId

ttl

Integer ttl

typeId

String typeId

workbinId

String workbinId

wrapup

WorkitemsQueueEventsNotificationWrapup wrapup

wrapupId

String wrapupId

Class com.mypurecloud.sdk.v2.model.WorkitemsQueueEventsNotificationWrapup

class WorkitemsQueueEventsNotificationWrapup extends Object implements Serializable

Serialized Fields

action

WorkitemsQueueEventsNotificationWrapup.ActionEnum action

code

String code

op

WorkitemsQueueEventsNotificationWrapup.OpEnum op

userId

String userId

Class com.mypurecloud.sdk.v2.model.WorkitemStatus

class WorkitemStatus extends Object implements Serializable

Serialized Fields

category

WorkitemStatus.CategoryEnum category

defaultDestinationStatus

WorkitemStatusReference defaultDestinationStatus

description

String description

destinationStatuses

List<WorkitemStatusReference> destinationStatuses

id

String id

name

String name

selfUri

String selfUri

statusTransitionDelaySeconds

Integer statusTransitionDelaySeconds

statusTransitionTime

LocalTime statusTransitionTime

worktype

WorktypeReference worktype

Class com.mypurecloud.sdk.v2.model.WorkitemStatusCreate

class WorkitemStatusCreate extends Object implements Serializable

Serialized Fields

category

WorkitemStatusCreate.CategoryEnum category

defaultDestinationStatusId

String defaultDestinationStatusId

description

String description

destinationStatusIds

List<String> destinationStatusIds

name

String name

statusTransitionDelaySeconds

Integer statusTransitionDelaySeconds

statusTransitionTime

LocalTime statusTransitionTime

Class com.mypurecloud.sdk.v2.model.WorkitemStatusReference

class WorkitemStatusReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WorkitemStatusUpdate

class WorkitemStatusUpdate extends Object implements Serializable

Serialized Fields

defaultDestinationStatusId

String defaultDestinationStatusId

description

String description

destinationStatusIds

List<String> destinationStatusIds

name

String name

statusTransitionDelaySeconds

Integer statusTransitionDelaySeconds

statusTransitionTime

LocalTime statusTransitionTime

Class com.mypurecloud.sdk.v2.model.WorkitemsUserEventsNotificationCustomAttribute

class WorkitemsUserEventsNotificationCustomAttribute extends Object implements Serializable

Serialized Fields

dataType

WorkitemsUserEventsNotificationCustomAttribute.DataTypeEnum dataType

value

String value

Class com.mypurecloud.sdk.v2.model.WorkitemsUserEventsNotificationDelta

class WorkitemsUserEventsNotificationDelta extends Object implements Serializable

Serialized Fields

field

String field

newValue

String newValue

oldValue

String oldValue

op

WorkitemsUserEventsNotificationDelta.OpEnum op

Class com.mypurecloud.sdk.v2.model.WorkitemsUserEventsNotificationWorkitem

class WorkitemsUserEventsNotificationWorkitem extends Object implements Serializable

Serialized Fields

alertTimeoutSeconds

Integer alertTimeoutSeconds

assigneeId

String assigneeId

assignmentId

String assignmentId

assignmentState

WorkitemsUserEventsNotificationWorkitem.AssignmentStateEnum assignmentState

changes

List<WorkitemsUserEventsNotificationDelta> changes

customFields

Map<String,WorkitemsUserEventsNotificationCustomAttribute> customFields

dateAssignmentStateChanged

String dateAssignmentStateChanged

dateClosed

String dateClosed

dateCreated

String dateCreated

dateDue

String dateDue

dateExpires

String dateExpires

dateModified

String dateModified

description

String description

durationSeconds

Integer durationSeconds

externalContactId

String externalContactId

externalTag

String externalTag

id

String id

languageId

String languageId

modifiedBy

String modifiedBy

name

String name

operation

WorkitemsUserEventsNotificationWorkitem.OperationEnum operation

priority

Integer priority

queueId

String queueId

reporterId

String reporterId

statusCategory

WorkitemsUserEventsNotificationWorkitem.StatusCategoryEnum statusCategory

statusId

String statusId

ttl

Integer ttl

typeId

String typeId

workbinId

String workbinId

wrapup

WorkitemsUserEventsNotificationWrapup wrapup

wrapupId

String wrapupId

Class com.mypurecloud.sdk.v2.model.WorkitemsUserEventsNotificationWrapup

class WorkitemsUserEventsNotificationWrapup extends Object implements Serializable

Serialized Fields

action

WorkitemsUserEventsNotificationWrapup.ActionEnum action

code

String code

op

WorkitemsUserEventsNotificationWrapup.OpEnum op

userId

String userId

Class com.mypurecloud.sdk.v2.model.WorkitemTerminate

class WorkitemTerminate extends Object implements Serializable

Serialized Fields

statusId

String statusId

Class com.mypurecloud.sdk.v2.model.WorkitemUpdate

class WorkitemUpdate extends Object implements Serializable

Serialized Fields

assigneeId

String assigneeId

assignmentOperation

WorkitemUpdate.AssignmentOperationEnum assignmentOperation

assignmentState

WorkitemUpdate.AssignmentStateEnum assignmentState

autoStatusTransition

Boolean autoStatusTransition

customFields

Map<String,Object> customFields

dateClosed

Date dateClosed

dateDue

Date dateDue

dateExpires

Date dateExpires

description

String description

durationSeconds

Integer durationSeconds

externalContactId

String externalContactId

externalTag

String externalTag

languageId

String languageId

name

String name

preferredAgentIds

List<String> preferredAgentIds

priority

Integer priority

queueId

String queueId

scoredAgents

List<WorkitemScoredAgentRequest> scoredAgents

skillIds

List<String> skillIds

statusId

String statusId

ttl

Integer ttl

workbinId

String workbinId

Class com.mypurecloud.sdk.v2.model.WorkitemVersion

class WorkitemVersion extends Object implements Serializable

Serialized Fields

alertTimeoutSeconds

Integer alertTimeoutSeconds

assignee

UserReferenceWithName assignee

assignmentState

WorkitemVersion.AssignmentStateEnum assignmentState

autoStatusTransition

Boolean autoStatusTransition

autoStatusTransitionDetail

AutoStatusTransitionDetail autoStatusTransitionDetail

customFields

Map<String,Object> customFields

dateAssignmentStateChanged

Date dateAssignmentStateChanged

dateClosed

Date dateClosed

dateCreated

Date dateCreated

dateDue

Date dateDue

dateExpires

Date dateExpires

dateModified

Date dateModified

dateStatusChanged

Date dateStatusChanged

description

String description

division

Division division

durationSeconds

Integer durationSeconds

externalContact

ExternalContactReference externalContact

externalTag

String externalTag

id

String id

language

LanguageReference language

modifiedBy

UserReference modifiedBy

name

String name

preferredAgents

List<UserReference> preferredAgents

priority

Integer priority

queue

QueueReference queue

reporter

UserReferenceWithName reporter

schema

WorkitemSchema schema

scoredAgents

List<WorkitemScoredAgent> scoredAgents

selfUri

String selfUri

skills

List<RoutingSkillReference> skills

status

WorkitemStatusReference status

statusCategory

WorkitemVersion.StatusCategoryEnum statusCategory

ttl

Integer ttl

type

WorktypeReference type

version

Integer version

workbin

WorkbinReference workbin

Class com.mypurecloud.sdk.v2.model.WorkitemVersionListing

class WorkitemVersionListing extends Object implements Serializable

Serialized Fields

after

String after

entities

List<WorkitemVersion> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WorkitemWrapup

class WorkitemWrapup extends Object implements Serializable

Serialized Fields

dateModified

Date dateModified

modifiedBy

UserReference modifiedBy

user

UserReference user

workitem

WorkitemReference workitem

wrapupCode

WrapupIdReference wrapupCode

Class com.mypurecloud.sdk.v2.model.WorkitemWrapupEntityListing

class WorkitemWrapupEntityListing extends Object implements Serializable

Serialized Fields

entities

List<WorkitemWrapup> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WorkitemWrapupUpdate

class WorkitemWrapupUpdate extends Object implements Serializable

Serialized Fields

action

WorkitemWrapupUpdate.ActionEnum action

wrapupCode

String wrapupCode

Class com.mypurecloud.sdk.v2.model.WorkPlan

class WorkPlan extends Object implements Serializable

Serialized Fields

agentCount

Integer agentCount

agents

List<DeletableUserReference> agents

constrainMaximumConsecutiveWorkingDays

Boolean constrainMaximumConsecutiveWorkingDays

constrainMaximumConsecutiveWorkingWeekends

Boolean constrainMaximumConsecutiveWorkingWeekends

constrainMinimumTimeBetweenShifts

Boolean constrainMinimumTimeBetweenShifts

constrainPaidTimeGranularity

Boolean constrainPaidTimeGranularity

constrainWeeklyPaidTime

Boolean constrainWeeklyPaidTime

enabled

Boolean enabled

flexibleWeeklyPaidTime

Boolean flexibleWeeklyPaidTime

id

String id

maximumConsecutiveWorkingDays

Integer maximumConsecutiveWorkingDays

maximumConsecutiveWorkingWeekends

Integer maximumConsecutiveWorkingWeekends

maximumDays

Integer maximumDays

maximumDaysOffPerPlanningPeriod

Integer maximumDaysOffPerPlanningPeriod

maximumPaidMinutesPerPlanningPeriod

Integer maximumPaidMinutesPerPlanningPeriod

metadata

WfmVersionedEntityMetadata metadata

minimumConsecutiveNonWorkingMinutesPerWeek

Integer minimumConsecutiveNonWorkingMinutesPerWeek

minimumDaysOffPerPlanningPeriod

Integer minimumDaysOffPerPlanningPeriod

minimumPaidMinutesPerPlanningPeriod

Integer minimumPaidMinutesPerPlanningPeriod

minimumShiftStartDistanceMinutes

Integer minimumShiftStartDistanceMinutes

minimumTimeBetweenShiftsMinutes

Integer minimumTimeBetweenShiftsMinutes

minimumWorkingDaysPerWeek

Integer minimumWorkingDaysPerWeek

name

String name

optionalDays

SetWrapperDayOfWeek optionalDays

paidTimeGranularityMinutes

Integer paidTimeGranularityMinutes

selfUri

String selfUri

shifts

List<WorkPlanShift> shifts

shiftStartVariances

ListWrapperShiftStartVariance shiftStartVariances

shiftStartVarianceType

WorkPlan.ShiftStartVarianceTypeEnum shiftStartVarianceType

valid

Boolean valid

weeklyExactPaidMinutes

Integer weeklyExactPaidMinutes

weeklyMaximumPaidMinutes

Integer weeklyMaximumPaidMinutes

weeklyMinimumPaidMinutes

Integer weeklyMinimumPaidMinutes

Class com.mypurecloud.sdk.v2.model.WorkPlanActivity

class WorkPlanActivity extends Object implements Serializable

Serialized Fields

activityCodeId

String activityCodeId

countsAsContiguousWorkTime

Boolean countsAsContiguousWorkTime

countsAsPaidTime

Boolean countsAsPaidTime

delete

Boolean delete

description

String description

earliestStartTimeMinutes

Integer earliestStartTimeMinutes

exactStartTimeMinutes

Integer exactStartTimeMinutes

flexibleStartTime

Boolean flexibleStartTime

id

String id

latestStartTimeMinutes

Integer latestStartTimeMinutes

lengthMinutes

Integer lengthMinutes

minimumLengthFromShiftEndMinutes

Integer minimumLengthFromShiftEndMinutes

minimumLengthFromShiftStartMinutes

Integer minimumLengthFromShiftStartMinutes

startTimeIncrementMinutes

Integer startTimeIncrementMinutes

startTimeIsRelativeToShiftStart

Boolean startTimeIsRelativeToShiftStart

validationId

String validationId

Class com.mypurecloud.sdk.v2.model.WorkPlanConfigurationViolationMessage

class WorkPlanConfigurationViolationMessage extends Object implements Serializable

Serialized Fields

arguments

List<WorkPlanValidationMessageArgument> arguments

severity

WorkPlanConfigurationViolationMessage.SeverityEnum severity

type

WorkPlanConfigurationViolationMessage.TypeEnum type

Class com.mypurecloud.sdk.v2.model.WorkPlanConstraintConflictMessage

class WorkPlanConstraintConflictMessage extends Object implements Serializable

Serialized Fields

arguments

List<WorkPlanValidationMessageArgument> arguments

type

WorkPlanConstraintConflictMessage.TypeEnum type

Class com.mypurecloud.sdk.v2.model.WorkPlanConstraintMessage

class WorkPlanConstraintMessage extends Object implements Serializable

Serialized Fields

arguments

List<WorkPlanValidationMessageArgument> arguments

type

WorkPlanConstraintMessage.TypeEnum type

Class com.mypurecloud.sdk.v2.model.WorkPlanListItemResponse

class WorkPlanListItemResponse extends Object implements Serializable

Serialized Fields

agentCount

Integer agentCount

agents

List<DeletableUserReference> agents

constrainMaximumConsecutiveWorkingDays

Boolean constrainMaximumConsecutiveWorkingDays

constrainMaximumConsecutiveWorkingWeekends

Boolean constrainMaximumConsecutiveWorkingWeekends

constrainMinimumTimeBetweenShifts

Boolean constrainMinimumTimeBetweenShifts

constrainPaidTimeGranularity

Boolean constrainPaidTimeGranularity

constrainWeeklyPaidTime

Boolean constrainWeeklyPaidTime

enabled

Boolean enabled

flexibleWeeklyPaidTime

Boolean flexibleWeeklyPaidTime

id

String id

maximumConsecutiveWorkingDays

Integer maximumConsecutiveWorkingDays

maximumConsecutiveWorkingWeekends

Integer maximumConsecutiveWorkingWeekends

maximumDays

Integer maximumDays

maximumDaysOffPerPlanningPeriod

Integer maximumDaysOffPerPlanningPeriod

maximumPaidMinutesPerPlanningPeriod

Integer maximumPaidMinutesPerPlanningPeriod

metadata

WfmVersionedEntityMetadata metadata

minimumConsecutiveNonWorkingMinutesPerWeek

Integer minimumConsecutiveNonWorkingMinutesPerWeek

minimumDaysOffPerPlanningPeriod

Integer minimumDaysOffPerPlanningPeriod

minimumPaidMinutesPerPlanningPeriod

Integer minimumPaidMinutesPerPlanningPeriod

minimumShiftStartDistanceMinutes

Integer minimumShiftStartDistanceMinutes

minimumTimeBetweenShiftsMinutes

Integer minimumTimeBetweenShiftsMinutes

minimumWorkingDaysPerWeek

Integer minimumWorkingDaysPerWeek

name

String name

optionalDays

SetWrapperDayOfWeek optionalDays

paidTimeGranularityMinutes

Integer paidTimeGranularityMinutes

selfUri

String selfUri

shifts

List<WorkPlanShift> shifts

shiftStartVariances

ListWrapperShiftStartVariance shiftStartVariances

shiftStartVarianceType

WorkPlanListItemResponse.ShiftStartVarianceTypeEnum shiftStartVarianceType

valid

Boolean valid

weeklyExactPaidMinutes

Integer weeklyExactPaidMinutes

weeklyMaximumPaidMinutes

Integer weeklyMaximumPaidMinutes

weeklyMinimumPaidMinutes

Integer weeklyMinimumPaidMinutes

Class com.mypurecloud.sdk.v2.model.WorkPlanListResponse

class WorkPlanListResponse extends Object implements Serializable

Serialized Fields

entities

List<WorkPlanListItemResponse> entities

Class com.mypurecloud.sdk.v2.model.WorkPlanPatternRequest

class WorkPlanPatternRequest extends Object implements Serializable

Serialized Fields

workPlanIds

List<String> workPlanIds

Class com.mypurecloud.sdk.v2.model.WorkPlanPatternResponse

class WorkPlanPatternResponse extends Object implements Serializable

Serialized Fields

workPlans

List<WorkPlanReference> workPlans

Class com.mypurecloud.sdk.v2.model.WorkPlanReference

class WorkPlanReference extends Object implements Serializable

Serialized Fields

id

String id

managementUnit

ManagementUnitReference managementUnit

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WorkPlanRotationAgentResponse

class WorkPlanRotationAgentResponse extends Object implements Serializable

Serialized Fields

dateRange

DateRangeWithOptionalEnd dateRange

position

Integer position

user

UserReference user

Class com.mypurecloud.sdk.v2.model.WorkPlanRotationListResponse

class WorkPlanRotationListResponse extends Object implements Serializable

Serialized Fields

entities

List<WorkPlanRotationResponse> entities

Class com.mypurecloud.sdk.v2.model.WorkPlanRotationReference

class WorkPlanRotationReference extends Object implements Serializable

Serialized Fields

id

String id

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WorkPlanRotationResponse

class WorkPlanRotationResponse extends Object implements Serializable

Serialized Fields

agentCount

Integer agentCount

agents

List<WorkPlanRotationAgentResponse> agents

dateRange

DateRangeWithOptionalEnd dateRange

enabled

Boolean enabled

id

String id

metadata

WfmVersionedEntityMetadata metadata

name

String name

pattern

WorkPlanPatternResponse pattern

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WorkPlanShift

class WorkPlanShift extends Object implements Serializable

Serialized Fields

activities

List<WorkPlanActivity> activities

constrainContiguousWorkTime

Boolean constrainContiguousWorkTime

constrainDayOff

Boolean constrainDayOff

constrainEarliestStopTime

Boolean constrainEarliestStopTime

constrainLatestStopTime

Boolean constrainLatestStopTime

constrainStopTime

Boolean constrainStopTime

dayOffRule

WorkPlanShift.DayOffRuleEnum dayOffRule

days

SetWrapperDayOfWeek days

delete

Boolean delete

earliestStartTimeMinutesFromMidnight

Integer earliestStartTimeMinutesFromMidnight

earliestStopTimeMinutesFromMidnight

Integer earliestStopTimeMinutesFromMidnight

exactPaidTimeMinutes

Integer exactPaidTimeMinutes

exactStartTimeMinutesFromMidnight

Integer exactStartTimeMinutesFromMidnight

flexiblePaidTime

Boolean flexiblePaidTime

flexibleStartTime

Boolean flexibleStartTime

id

String id

latestStartTimeMinutesFromMidnight

Integer latestStartTimeMinutesFromMidnight

latestStopTimeMinutesFromMidnight

Integer latestStopTimeMinutesFromMidnight

maximumContiguousWorkTimeMinutes

Integer maximumContiguousWorkTimeMinutes

maximumPaidTimeMinutes

Integer maximumPaidTimeMinutes

minimumContiguousWorkTimeMinutes

Integer minimumContiguousWorkTimeMinutes

minimumPaidTimeMinutes

Integer minimumPaidTimeMinutes

name

String name

startIncrementMinutes

Integer startIncrementMinutes

validationId

String validationId

Class com.mypurecloud.sdk.v2.model.WorkPlanValidationMessageArgument

class WorkPlanValidationMessageArgument extends Object implements Serializable

Serialized Fields

type

WorkPlanValidationMessageArgument.TypeEnum type

value

String value

Class com.mypurecloud.sdk.v2.model.WorkPlanValidationRequest

class WorkPlanValidationRequest extends Object implements Serializable

Serialized Fields

agentCount

Integer agentCount

agents

List<DeletableUserReference> agents

constrainMaximumConsecutiveWorkingDays

Boolean constrainMaximumConsecutiveWorkingDays

constrainMaximumConsecutiveWorkingWeekends

Boolean constrainMaximumConsecutiveWorkingWeekends

constrainMinimumTimeBetweenShifts

Boolean constrainMinimumTimeBetweenShifts

constrainPaidTimeGranularity

Boolean constrainPaidTimeGranularity

constrainWeeklyPaidTime

Boolean constrainWeeklyPaidTime

enabled

Boolean enabled

flexibleWeeklyPaidTime

Boolean flexibleWeeklyPaidTime

id

String id

maximumConsecutiveWorkingDays

Integer maximumConsecutiveWorkingDays

maximumConsecutiveWorkingWeekends

Integer maximumConsecutiveWorkingWeekends

maximumDays

Integer maximumDays

maximumDaysOffPerPlanningPeriod

Integer maximumDaysOffPerPlanningPeriod

maximumPaidMinutesPerPlanningPeriod

Integer maximumPaidMinutesPerPlanningPeriod

minimumConsecutiveNonWorkingMinutesPerWeek

Integer minimumConsecutiveNonWorkingMinutesPerWeek

minimumDaysOffPerPlanningPeriod

Integer minimumDaysOffPerPlanningPeriod

minimumPaidMinutesPerPlanningPeriod

Integer minimumPaidMinutesPerPlanningPeriod

minimumShiftStartDistanceMinutes

Integer minimumShiftStartDistanceMinutes

minimumTimeBetweenShiftsMinutes

Integer minimumTimeBetweenShiftsMinutes

minimumWorkingDaysPerWeek

Integer minimumWorkingDaysPerWeek

name

String name

optionalDays

SetWrapperDayOfWeek optionalDays

paidTimeGranularityMinutes

Integer paidTimeGranularityMinutes

selfUri

String selfUri

shifts

List<WorkPlanShift> shifts

shiftStartVariances

ListWrapperShiftStartVariance shiftStartVariances

shiftStartVarianceType

WorkPlanValidationRequest.ShiftStartVarianceTypeEnum shiftStartVarianceType

valid

Boolean valid

weeklyExactPaidMinutes

Integer weeklyExactPaidMinutes

weeklyMaximumPaidMinutes

Integer weeklyMaximumPaidMinutes

weeklyMinimumPaidMinutes

Integer weeklyMinimumPaidMinutes

Class com.mypurecloud.sdk.v2.model.Workspace

class Workspace extends Object implements Serializable

Serialized Fields

acl

List<String> acl

bucket

String bucket

dateCreated

Date dateCreated

dateModified

Date dateModified

description

String description

id

String id

isCurrentUserWorkspace

Boolean isCurrentUserWorkspace

name

String name

selfUri

String selfUri

summary

WorkspaceSummary summary

type

Workspace.TypeEnum type

user

DomainEntityRef user

Class com.mypurecloud.sdk.v2.model.WorkspaceCreate

class WorkspaceCreate extends Object implements Serializable

Serialized Fields

bucket

String bucket

description

String description

name

String name

Class com.mypurecloud.sdk.v2.model.WorkspaceEntityListing

class WorkspaceEntityListing extends Object implements Serializable

Serialized Fields

entities

List<Workspace> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.WorkspaceMember

class WorkspaceMember extends Object implements Serializable

Serialized Fields

group

Group group

id

String id

member

DomainEntityRef member

memberType

WorkspaceMember.MemberTypeEnum memberType

name

String name

securityProfile

SecurityProfile securityProfile

selfUri

String selfUri

user

User user

workspace

DomainEntityRef workspace

Class com.mypurecloud.sdk.v2.model.WorkspaceMemberEntityListing

class WorkspaceMemberEntityListing extends Object implements Serializable

Serialized Fields

entities

List<WorkspaceMember> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.WorkspaceSummary

class WorkspaceSummary extends Object implements Serializable

Serialized Fields

totalDocumentByteCount

Long totalDocumentByteCount

totalDocumentCount

Long totalDocumentCount

Class com.mypurecloud.sdk.v2.model.Worktype

class Worktype extends Object implements Serializable

Serialized Fields

assignmentEnabled

Boolean assignmentEnabled

dateCreated

Date dateCreated

dateModified

Date dateModified

defaultDueDurationSeconds

Integer defaultDueDurationSeconds

defaultDurationSeconds

Integer defaultDurationSeconds

defaultExpirationSeconds

Integer defaultExpirationSeconds

defaultLanguage

LanguageReference defaultLanguage

defaultPriority

Integer defaultPriority

defaultQueue

QueueReference defaultQueue

defaultSkills

List<RoutingSkillReference> defaultSkills

defaultStatus

WorkitemStatusReference defaultStatus

defaultTtlSeconds

Integer defaultTtlSeconds

defaultWorkbin

WorkbinReference defaultWorkbin

description

String description

division

Division division

id

String id

modifiedBy

UserReference modifiedBy

name

String name

schema

WorkitemSchema schema

selfUri

String selfUri

statuses

List<WorkitemStatus> statuses

Class com.mypurecloud.sdk.v2.model.WorktypeChangeListing

class WorktypeChangeListing extends Object implements Serializable

Serialized Fields

after

String after

entities

List<WorkitemsChangeWorktypeDelta> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WorktypeCreate

class WorktypeCreate extends Object implements Serializable

Serialized Fields

assignmentEnabled

Boolean assignmentEnabled

defaultDueDurationSeconds

Integer defaultDueDurationSeconds

defaultDurationSeconds

Integer defaultDurationSeconds

defaultExpirationSeconds

Integer defaultExpirationSeconds

defaultLanguageId

String defaultLanguageId

defaultPriority

Integer defaultPriority

defaultQueueId

String defaultQueueId

defaultSkillIds

List<String> defaultSkillIds

defaultTtlSeconds

Integer defaultTtlSeconds

defaultWorkbinId

String defaultWorkbinId

description

String description

disableDefaultStatusCreation

Boolean disableDefaultStatusCreation

divisionId

String divisionId

name

String name

schemaId

String schemaId

schemaVersion

Integer schemaVersion

Class com.mypurecloud.sdk.v2.model.WorktypeDelta

class WorktypeDelta extends Object implements Serializable

Serialized Fields

assignmentEnabled

WorkitemsAttributeChangeBoolean assignmentEnabled

dateModified

WorkitemsAttributeChangeInstant dateModified

defaultDueDurationSeconds

WorkitemsAttributeChangeInteger defaultDueDurationSeconds

defaultDurationSeconds

WorkitemsAttributeChangeInteger defaultDurationSeconds

defaultExpirationSeconds

WorkitemsAttributeChangeInteger defaultExpirationSeconds

defaultLanguageId

WorkitemsAttributeChangeString defaultLanguageId

defaultPriority

WorkitemsAttributeChangeInteger defaultPriority

defaultQueueId

WorkitemsAttributeChangeString defaultQueueId

defaultSkillIds

WorkitemsAttributeChangeList defaultSkillIds

defaultStatusId

WorkitemsAttributeChangeString defaultStatusId

defaultTtlSeconds

WorkitemsAttributeChangeInteger defaultTtlSeconds

defaultWorkbinId

WorkitemsAttributeChangeString defaultWorkbinId

description

WorkitemsAttributeChangeString description

modifiedBy

WorkitemsAttributeChangeString modifiedBy

name

WorkitemsAttributeChangeString name

schemaId

WorkitemsAttributeChangeString schemaId

schemaVersion

WorkitemsAttributeChangeString schemaVersion

statuses

WorkitemsAttributeChangeList statuses

Class com.mypurecloud.sdk.v2.model.WorktypeQueryEntityListing

class WorktypeQueryEntityListing extends Object implements Serializable

Serialized Fields

after

String after

count

Integer count

entities

List<Worktype> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WorktypeQueryRequest

class WorktypeQueryRequest extends Object implements Serializable

Serialized Fields

after

String after

attributes

List<String> attributes

filters

List<WorkitemFilter> filters

pageSize

Integer pageSize

select

WorktypeQueryRequest.SelectEnum select

sort

WorktypeQuerySort sort

Class com.mypurecloud.sdk.v2.model.WorktypeQuerySort

class WorktypeQuerySort extends Object implements Serializable

Serialized Fields

ascending

Boolean ascending

name

WorktypeQuerySort.NameEnum name

Class com.mypurecloud.sdk.v2.model.WorktypeReference

class WorktypeReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WorktypeUpdate

class WorktypeUpdate extends Object implements Serializable

Serialized Fields

assignmentEnabled

Boolean assignmentEnabled

defaultDueDurationSeconds

Integer defaultDueDurationSeconds

defaultDurationSeconds

Integer defaultDurationSeconds

defaultExpirationSeconds

Integer defaultExpirationSeconds

defaultLanguageId

String defaultLanguageId

defaultPriority

Integer defaultPriority

defaultQueueId

String defaultQueueId

defaultSkillIds

List<String> defaultSkillIds

defaultStatusId

String defaultStatusId

defaultTtlSeconds

Integer defaultTtlSeconds

defaultWorkbinId

String defaultWorkbinId

description

String description

name

String name

schemaId

String schemaId

schemaVersion

Integer schemaVersion

Class com.mypurecloud.sdk.v2.model.WorktypeVersion

class WorktypeVersion extends Object implements Serializable

Serialized Fields

assignmentEnabled

Boolean assignmentEnabled

dateCreated

Date dateCreated

dateModified

Date dateModified

defaultDueDurationSeconds

Integer defaultDueDurationSeconds

defaultDurationSeconds

Integer defaultDurationSeconds

defaultExpirationSeconds

Integer defaultExpirationSeconds

defaultLanguage

LanguageReference defaultLanguage

defaultPriority

Integer defaultPriority

defaultQueue

QueueReference defaultQueue

defaultSkills

List<RoutingSkillReference> defaultSkills

defaultStatus

WorkitemStatusReference defaultStatus

defaultTtlSeconds

Integer defaultTtlSeconds

defaultWorkbin

WorkbinReference defaultWorkbin

description

String description

division

Division division

id

String id

modifiedBy

UserReference modifiedBy

name

String name

schema

WorkitemSchema schema

selfUri

String selfUri

statuses

List<WorkitemStatus> statuses

version

Integer version

Class com.mypurecloud.sdk.v2.model.WorktypeVersionListing

class WorktypeVersionListing extends Object implements Serializable

Serialized Fields

after

String after

entities

List<WorktypeVersion> entities

nextUri

String nextUri

previousUri

String previousUri

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.Wrapup

class Wrapup extends Object implements Serializable

Serialized Fields

code

String code

durationSeconds

Integer durationSeconds

endTime

Date endTime

name

String name

notes

String notes

provisional

Boolean provisional

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.WrapupCode

class WrapupCode extends Object implements Serializable

Serialized Fields

createdBy

String createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

division

StarrableDivision division

id

String id

modifiedBy

String modifiedBy

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WrapUpCodeConfig

class WrapUpCodeConfig extends Object implements Serializable

Serialized Fields

values

List<String> values

Class com.mypurecloud.sdk.v2.model.WrapupCodeEntityListing

class WrapupCodeEntityListing extends Object implements Serializable

Serialized Fields

entities

List<WrapupCode> entities

firstUri

String firstUri

lastUri

String lastUri

nextUri

String nextUri

pageCount

Integer pageCount

pageNumber

Integer pageNumber

pageSize

Integer pageSize

previousUri

String previousUri

selfUri

String selfUri

total

Long total

Class com.mypurecloud.sdk.v2.model.WrapUpCodeMapping

class WrapUpCodeMapping extends Object implements Serializable

Serialized Fields

dateCreated

Date dateCreated

dateModified

Date dateModified

defaultSet

List<WrapUpCodeMapping.DefaultSetEnum> defaultSet

id

String id

mapping

Map<String,List<String>> mapping

name

String name

selfUri

String selfUri

version

Integer version

Class com.mypurecloud.sdk.v2.model.WrapUpCodeReference

class WrapUpCodeReference extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WrapupCodeRequest

class WrapupCodeRequest extends Object implements Serializable

Serialized Fields

createdBy

String createdBy

dateCreated

Date dateCreated

dateModified

Date dateModified

id

String id

modifiedBy

String modifiedBy

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WrapupDetailEventTopicWrapupEvent

class WrapupDetailEventTopicWrapupEvent extends Object implements Serializable

Serialized Fields

addressFrom

String addressFrom

addressTo

String addressTo

ani

String ani

callbackNumbers

List<String> callbackNumbers

callbackScheduledTime

Integer callbackScheduledTime

callbackUserName

String callbackUserName

conversationExternalContactIds

List<String> conversationExternalContactIds

conversationExternalOrganizationIds

List<String> conversationExternalOrganizationIds

conversationId

String conversationId

direction

WrapupDetailEventTopicWrapupEvent.DirectionEnum direction

dnis

String dnis

eventTime

Integer eventTime

mediaType

WrapupDetailEventTopicWrapupEvent.MediaTypeEnum mediaType

messageType

WrapupDetailEventTopicWrapupEvent.MessageTypeEnum messageType

participantId

String participantId

provider

String provider

queueId

String queueId

sessionId

String sessionId

subject

String subject

wrapupCode

String wrapupCode

wrapupDurationMs

Integer wrapupDurationMs

wrapupNotes

String wrapupNotes

Class com.mypurecloud.sdk.v2.model.WrapupIdReference

class WrapupIdReference extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WrapupInput

class WrapupInput extends Object implements Serializable

Serialized Fields

code

String code

disableEndTimeUpdates

Boolean disableEndTimeUpdates

durationSeconds

Integer durationSeconds

endTime

Date endTime

name

String name

notes

String notes

provisional

Boolean provisional

tags

List<String> tags

Class com.mypurecloud.sdk.v2.model.WritableDialerContact

class WritableDialerContact extends Object implements Serializable

Serialized Fields

callable

Boolean callable

contactableStatus

Map<String,ContactableStatus> contactableStatus

contactListId

String contactListId

data

Map<String,String> data

id

String id

latestEmailEvaluations

Map<String,MessageEvaluation> latestEmailEvaluations

latestSmsEvaluations

Map<String,MessageEvaluation> latestSmsEvaluations

phoneNumberStatus

Map<String,PhoneNumberStatus> phoneNumberStatus

Class com.mypurecloud.sdk.v2.model.WritableDivision

class WritableDivision extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri

Class com.mypurecloud.sdk.v2.model.WritableEntity

class WritableEntity extends Object implements Serializable

Serialized Fields

id

String id

Class com.mypurecloud.sdk.v2.model.WritableStarrableDivision

class WritableStarrableDivision extends Object implements Serializable

Serialized Fields

id

String id

name

String name

selfUri

String selfUri